[DOCS] Background-session docs omit `--bg --name` post-spawn confirmation output
Documentation Type
Incorrect/outdated documentation
Documentation Location
https://code.claude.com/docs/en/agent-view
Section/Topic
"From your shell" in the background sessions / agent view docs
Current Documentation
The docs currently say:
Pass--nameto set the session's display name in agent view instead of the auto-generated one: ``bash claude --bg --name "flaky-test-fix" "investigate the flaky SettingsChangeDetector test"`After backgrounding, Claude prints the session's short ID and the commands for managing it:`text backgrounded · 7c5dcf5d claude agents list sessions claude attach 7c5dcf5d open in this terminal claude logs 7c5dcf5d show recent output claude stop 7c5dcf5d stop this session``
The CLI reference also says:
--bgstarts the session as a background agent and returns immediately, printing the session ID and management commands.--namesets a display name for the session.
What's Wrong or Missing?
For the v2.1.144 change, these pages do not say that claude --bg --name <label> also echoes the chosen name in the immediate post-spawn confirmation.
The current agent-view example shows a named background launch, but the output block only shows the short ID. That makes it look like the name is visible only later in agent view, /resume, or the terminal title, instead of also appearing right after the session is spawned.
Suggested Improvement
Update the background-session docs so the --bg --name flow shows the current confirmation output.
At minimum:
- Revise the
agent-viewexample so the sample confirmation includes the echoed session name along with the short ID. - Add one sentence to the CLI reference clarifying that combining
--bgwith--nameincludes the name in the immediate confirmation output. - Note that this behavior applies to the v2.1.144 change so readers know the output differs from older versions.
Impact
Medium - Makes feature difficult to understand
Additional Context
Affected Pages:
| Page | Line(s) | Context |
|------|---------|---------|
| https://code.claude.com/docs/en/agent-view | 287-300 | Shows claude --bg --name ... but the sample post-spawn output only includes the short ID and management commands |
| https://code.claude.com/docs/en/cli-reference | 59, 87 | Documents --bg output and --name separately, but not that the confirmation output includes the chosen name when both flags are used together |
Total scope: 2 pages affected
This issue has 2 comments on GitHub. Read the full discussion on GitHub ↗