Skip to content

Commit 90c9e7e

Browse files
samkeengithub-actions[bot]
authored andcommitted
chore: sync catalog with upstream docs
Auto-generated by .github/workflows/catalog-drift.yml.
1 parent 48cb987 commit 90c9e7e

9 files changed

Lines changed: 429 additions & 67 deletions

File tree

catalog/cli-reference.json

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"source": "https://code.claude.com/docs/en/cli-reference.md",
3-
"fetchedAt": "2026-05-18T12:35:00.301Z",
4-
"commandCount": 25,
5-
"flagCount": 64,
3+
"fetchedAt": "2026-06-08T13:09:24.510Z",
4+
"commandCount": 27,
5+
"flagCount": 66,
66
"commands": [
77
{
88
"name": "cat file | claude -p \"query\"",
@@ -41,8 +41,8 @@
4141
},
4242
{
4343
"name": "claude agents",
44-
"description": "Open [agent view](/en/agent-view) to monitor and dispatch parallel background sessions. Use `--cwd <path>` to show only sessions started under that directory",
45-
"example": "`claude agents`"
44+
"description": "Open [agent view](/en/agent-view) to monitor and dispatch parallel background sessions. Use `--cwd <path>` to show only sessions started under that directory, or `--json` to print live sessions as a JSON array for scripting. Pass `--permission-mode`, `--model`, `--effort`, or `--agent` to set [defaults for dispatched sessions](/en/agent-view#permission-mode-model-and-effort). Accepts `--settings`, `--add-dir`, `--plugin-dir`, and `--mcp-config` like the top-level `claude` command. Opening agent view requires an interactive terminal",
45+
"example": "`claude agents --json`"
4646
},
4747
{
4848
"name": "claude attach <id>",
@@ -69,6 +69,16 @@
6969
"description": "Print the built-in [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) classifier rules as JSON. Use `claude auto-mode config` to see your effective config with settings applied",
7070
"example": "`claude auto-mode defaults > rules.json`"
7171
},
72+
{
73+
"name": "claude daemon status",
74+
"description": "Print the background-session [supervisor's](/en/agent-view#the-supervisor-process) state, version, socket directory, and worker count for diagnostics. Exits 1 if the supervisor isn't running",
75+
"example": "`claude daemon status`"
76+
},
77+
{
78+
"name": "claude daemon stop --any",
79+
"description": "Stop the background-session [supervisor](/en/agent-view#the-supervisor-process) and the sessions it hosts. Pass `--keep-workers` to leave background sessions running so the next supervisor reconnects to them. `--any` confirms stopping an on-demand supervisor, which is the default. Use this to recover from an [unresponsive supervisor](/en/agent-view#agent-view-says-the-background-service-did-not-respond)",
80+
"example": "`claude daemon stop --any --keep-workers`"
81+
},
7282
{
7383
"name": "claude install [version]",
7484
"description": "Install or reinstall the native binary. Accepts a version like `2.1.118`, or `stable` or `latest`. See [Install a specific version](/en/setup#install-a-specific-version)",
@@ -101,12 +111,12 @@
101111
},
102112
{
103113
"name": "claude respawn <id>",
104-
"description": "Restart a stopped [background session](/en/agent-view#manage-sessions-from-the-shell) with its conversation intact. Use `--all` to restart every stopped session",
114+
"description": "Restart a [background session](/en/agent-view#manage-sessions-from-the-shell), running or stopped, with its conversation intact. Use `--all` to restart every running session, e.g. to pick up an updated Claude Code binary",
105115
"example": "`claude respawn 7c5dcf5d`"
106116
},
107117
{
108118
"name": "claude rm <id>",
109-
"description": "Remove a [background session](/en/agent-view#manage-sessions-from-the-shell) from the list",
119+
"description": "Remove a [background session](/en/agent-view#manage-sessions-from-the-shell) from the list. The conversation transcript stays on your local machine, available through `claude --resume`",
110120
"example": "`claude rm 7c5dcf5d`"
111121
},
112122
{
@@ -178,7 +188,7 @@
178188
},
179189
{
180190
"name": "--bg",
181-
"description": "Start the session as a [background agent](/en/agent-view) and return immediately. Prints the session ID and management commands. Combine with `--agent` to run a specific subagent",
191+
"description": "Start the session as a [background agent](/en/agent-view) and return immediately. Prints the session ID and management commands. Combine with `--exec` to run a shell command as a background job instead of a Claude session, or with `--agent` to run a specific subagent",
182192
"example": "`claude --bg \"investigate the flaky test\"`"
183193
},
184194
{
@@ -218,7 +228,7 @@
218228
},
219229
{
220230
"name": "--disallowedTools",
221-
"description": "Tools that are removed from the model's context and cannot be used",
231+
"description": "Deny rules. A bare tool name removes that tool from the model's context. A scoped rule such as `Bash(rm *)` leaves the tool available and denies only matching calls",
222232
"example": "`\"Bash(git log *)\" \"Bash(git diff *)\" \"Edit\"`"
223233
},
224234
{
@@ -236,9 +246,14 @@
236246
"description": "Move per-machine sections from the system prompt (working directory, environment info, memory paths, git-repo flag) into the first user message. Improves prompt-cache reuse across different users and machines running the same task. Only applies with the default system prompt; ignored when `--system-prompt` or `--system-prompt-file` is set. Use with `-p` for scripted, multi-user workloads",
237247
"example": "`claude -p --exclude-dynamic-system-prompt-sections \"query\"`"
238248
},
249+
{
250+
"name": "--exec",
251+
"description": "Run a shell command as a PTY-backed background job instead of starting a Claude session. Use with `--bg` to launch from the shell",
252+
"example": "`claude --bg --exec 'pytest -x'`"
253+
},
239254
{
240255
"name": "--fallback-model",
241-
"description": "Enable automatic fallback to specified model when default model is overloaded (print mode only)",
256+
"description": "Enable automatic fallback to a specified model when the default model is overloaded or not available, for example a retired model. Takes effect in print mode (`-p`) and in [background sessions](/en/agent-view), which run non-interactively; ignored in an interactive session",
242257
"example": "`claude -p --fallback-model sonnet \"query\"`"
243258
},
244259
{
@@ -259,12 +274,12 @@
259274
{
260275
"name": "--include-hook-events",
261276
"description": "Include all hook lifecycle events in the output stream. Requires `--output-format stream-json`",
262-
"example": "`claude -p --output-format stream-json --include-hook-events \"query\"`"
277+
"example": "`claude -p --output-format stream-json --verbose --include-hook-events \"query\"`"
263278
},
264279
{
265280
"name": "--include-partial-messages",
266281
"description": "Include partial streaming events in output. Requires `--print` and `--output-format stream-json`",
267-
"example": "`claude -p --output-format stream-json --include-partial-messages \"query\"`"
282+
"example": "`claude -p --output-format stream-json --verbose --include-partial-messages \"query\"`"
268283
},
269284
{
270285
"name": "--init",
@@ -346,6 +361,11 @@
346361
"description": "Fetch a plugin `.zip` archive from a URL for this session only. Repeat the flag for multiple plugins, or pass space-separated URLs in a single quoted value",
347362
"example": "`claude --plugin-url https://example.com/plugin.zip`"
348363
},
364+
{
365+
"name": "--prompt-suggestions",
366+
"description": "Emit a `prompt_suggestion` message after each turn with a predicted next user prompt. Requires `--print`, `--output-format stream-json`, and `--verbose`. See [Prompt suggestions](/en/interactive-mode#prompt-suggestions)",
367+
"example": "`claude -p --prompt-suggestions --output-format stream-json --verbose \"query\"`"
368+
},
349369
{
350370
"name": "--remote",
351371
"description": "Create a new [web session](/en/claude-code-on-the-web) on claude.ai with the provided task description",
@@ -359,7 +379,7 @@
359379
{
360380
"name": "--replay-user-messages",
361381
"description": "Re-emit user messages from stdin back on stdout for acknowledgment. Requires `--input-format stream-json` and `--output-format stream-json`",
362-
"example": "`claude -p --input-format stream-json --output-format stream-json --replay-user-messages`"
382+
"example": "`claude -p --input-format stream-json --output-format stream-json --verbose --replay-user-messages`"
363383
},
364384
{
365385
"name": "--session-id",
@@ -438,7 +458,7 @@
438458
},
439459
{
440460
"name": "`--resume`, `-r`",
441-
"description": "Resume a specific session by ID or name, or show an interactive picker to choose a session. Includes sessions that added this directory with `/add-dir`",
461+
"description": "Resume a specific session by ID or name, or show an interactive picker to choose a session. Includes sessions that added this directory with `/add-dir`. As of v2.1.144, [background sessions](/en/agent-view) appear in the picker marked with `bg`",
442462
"example": "`claude --resume auth-refactor`"
443463
},
444464
{

0 commit comments

Comments
 (0)