[DOCS] Agent view docs omit `claude agents --json` for scripted session listing
Documentation Type
Missing documentation (feature not documented)
Documentation Location
https://code.claude.com/docs/en/agent-view
Section/Topic
"Manage sessions from the shell" and the claude agents command reference
Current Documentation
The docs currently say:
Every background session has a short ID you can use from the shell. The ID is printed when you start a session withclaude --bg, and each session's ID is its directory name under~/.claude/jobs/. These commands are useful for scripting or when you don't want to open agent view. |claude agents| Open agent view | |claude agents --cwd <path>| Open agent view scoped to sessions started under<path>|
The CLI reference also currently says:
|claude agents| Open agent view to monitor and dispatch parallel background sessions. Use--cwd <path>to show only sessions started under that directory. Pass--permission-mode,--model, or--effortto set defaults for dispatched sessions. Accepts--settings,--add-dir,--plugin-dir, and--mcp-configlike the top-levelclaudecommand. Requires an interactive terminal |
What's Wrong or Missing?
The v2.1.145 release notes add claude agents --json to list live Claude sessions as JSON for scripting, but the main docs still describe claude agents only as an interactive agent-view entry point.
That leaves the scripting-oriented session-management docs missing the supported machine-readable command for:
- session pickers
- status bars
- tmux-resurrect or similar restore tooling
The current pages also do not explain whether --cwd can be combined with --json, or position claude agents --json as the supported alternative to inferring session state from local files such as ~/.claude/daemon/roster.json and ~/.claude/jobs/<id>/state.json.
Suggested Improvement
Add claude agents --json to both:
- the
claude agentsrow in the CLI reference - the "Manage sessions from the shell" table in agent view
Document at least:
- that
claude agents --jsonlists live/background sessions as JSON for scripting - whether
--cwd <path>also works with--json - one short example such as
claude agents --jsonfor a session picker or status-bar integration
Impact
Medium - Makes feature difficult to understand
Additional Context
Affected Pages:
| Page | Line(s) | Context |
|------|---------|---------|
| https://code.claude.com/docs/en/agent-view | 395-400 | The shell-management section says these commands are useful for scripting, but it lists only claude agents and claude agents --cwd <path> |
| https://code.claude.com/docs/en/agent-view | 429-433 | The same page points readers to local state files such as ~/.claude/daemon/roster.json and ~/.claude/jobs/<id>/state.json, but does not document the new JSON CLI output |
| https://code.claude.com/docs/en/cli-reference | 27 | The claude agents command entry documents interactive usage and --cwd, but not --json |
Total scope: 2 pages affected
The missing flag is specifically relevant to the v2.1.145 addition of claude agents --json for scripted session listing.
This issue has 2 comments on GitHub. Read the full discussion on GitHub ↗