gurl docs

Print one compact reference of every command, flag and concept. This is the first command an AI agent should run.

Synopsis

gurl docs [command [subcommand]] [flags]

gurl docs is generated from the binary’s own command tree at runtime, so it always matches the installed version. It lists every command and subcommand with its arguments and flags (type, default, aliases), followed by short sections on:

• agent mode
• placeholders (typed and dynamic) and environment aliases
• scope precedence
• extract rules
• --persist
• the run --json shape
• exit codes
• gurl exec and gurl diag

gurl docs <command> narrows the output to one command (for example gurl docs run or gurl docs env set).

Flags

The JSON shape is:

{"commands":[{"path","usage","args","flags":[{"name","aliases","type","default","usage"}]}],
 "sections":{...}}

Examples

Whole reference

gurl docs

One command

gurl docs run

gurl run  — Execute a saved request (aliases: r, execute)
  --env, -e <string>  Environment name to use for variable substitution
  --var, -v <[]string>  Variable substitution (--var key=value)
  ...
  --fail  Exit non-zero when the response status is not 2xx (body is still printed)
  --json, -j  JSON object per execution (NDJSON for --chain/--data), nothing else on stdout

JSON for agents

gurl docs --json

Related commands

• Agent mode - How agents should drive gurl
• CLI Reference - All commands