Skip to content

fix(help): show trace paths as optional - #3446

Open
thymikee wants to merge 1 commit into
mainfrom
fix/trace-help-optional-path
Open

thymikee wants to merge 1 commit into
mainfrom
fix/trace-help-optional-path

Conversation

@thymikee

@thymikee thymikee commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

Summary

agent-device help trace printed trace start <path> | trace stop <path>, which marks the path as required, and its description said "when an explicit path is required". Both paths are optional:

  • trace start with no path writes a timestamped trace log named after the session in the daemon's sessions directory (trace-runtime.ts:34, SessionStore.defaultTracePath).
  • trace stop <path> moves the finished trace to that path (relocateTraceOutput).

The command schema already declared the path optional (positionalArgs: ['start|stop', 'path?']); only the hand-written usage and description were wrong. This PR:

  • changes the usage and list usage to trace start [path] | trace stop [path]
  • rewrites the description to say what happens with and without a path. The same text is the MCP tool description, so it uses no CLI placeholders, which command-surface-metadata.test.ts enforces.
  • drops the cliDetail line that repeated the wrong rule
  • updates the cli-help-topics.test.ts assertion that pinned the wrong usage

Found while trimming commands.md (#3441), which already documents trace start [path].

Validation

  • pnpm check:affected --run passed on 5026910.
  • cli-help-topics and command-surface-metadata pass (37 tests).
  • help trace now prints trace start [path] | trace stop [path].
  • Help and metadata text only, so no device runs.

🤖 Generated with Claude Code

View guided diff Turn on auto-fix

…e goes

`help trace` printed `trace start <path> | trace stop <path>`, but both paths
are optional: start falls back to the session's default trace path and a
path on stop moves the finished trace there (trace-runtime.ts).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Size Report

Metric Base Current Diff
Installed (including dependencies) 5.17 MB 5.17 MB -10 B
Package (unpacked) 5.17 MB 5.17 MB -10 B
Package (download) 1.55 MB 1.55 MB -9 B

Startup median (7 runs, lower is better):

Scenario Base Current Diff
CLI --version 23.0 ms 21.1 ms -1.9 ms
CLI --help 56.1 ms 52.9 ms -3.2 ms

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

View guided diff | Turn on auto-fix | Re-trigger cubic

@thymikee

Copy link
Copy Markdown
Member Author

I found no problems in 5026910. The change to show trace paths as optional in the help output looks right. All 19 checks pass and there are no conflicts, so it is ready for review. I did not read the body of defaultTracePath, so I have not checked the "timestamped" wording in the description. I also did not look for generated docs or skills that quote the old usage, beyond a grep that found no copies of the old <path> form.

@thymikee thymikee added the ready-for-human Valid work that needs human implementation, judgment, or maintainer merge label Oct 11, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-human Valid work that needs human implementation, judgment, or maintainer merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant