Skip to content

docs(cli): align axl --help option descriptions and list --thinking values - #495

Open
wufangyong973 wants to merge 1 commit into
Observal:mainfrom
wufangyong973:gfi/423-help-align
Open

wufangyong973 wants to merge 1 commit into
Observal:mainfrom
wufangyong973:gfi/423-help-align

Conversation

@wufangyong973

@wufangyong973 wufangyong973 commented Oct 12, 2026 •

Copy link
Copy Markdown

Closes #423.

What changed

In packages/cli/src/main.ts, the HELP string used by axl --help:

Alignment — seven option descriptions were indented one column further
than every other option line (their descriptions began at 0-based col 22
instead of 21):

  • --json
  • --web-tools
  • --no-web-tools
  • --web-fetch
  • --no-web-fetch
  • --web-search

Each was trimmed by one space so all description text now begins at the same
column. The two long-flag lines (--max-output-tokens, --http-idle-timeout)
were left at their wider col-33 position, as the issue explicitly permits.

Accepted values — the --thinking <level> line previously read
"Select the initial reasoning effort" with no indication of which values are
valid. It now reads:

Select reasoning effort: off, minimal, low, medium, high, xhigh, max

This matches the values in THINKING_LEVELS / ThinkingLevel in
packages/protocol/src/events.ts, and mirrors how --sandbox <kind> names
its accepted kinds.

Verification

  • axl --help output is now consistently aligned (all descriptions at col 21
    except the two long flags at col 33).
  • The --thinking description names all seven valid levels.
  • No test changes required; packages/cli/test/unsafe-cli.test.ts does not
    assert on the help text content.

Summary by CodeRabbit

  • Documentation
    • Updated the --thinking help text to list accepted reasoning-effort levels.
    • Adjusted spacing in CLI help text; option wording and behavior are unchanged.

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 79952c8f-e9c4-4b83-b660-c5167fecf99c

📥 Commits

Reviewing files that changed from the base of the PR and between 4393da4 and 9fd0905.


📒 Files selected for processing (1)
  • packages/cli/src/main.ts

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.



📝 Walkthrough

Walkthrough

The CLI help text now lists the accepted --thinking levels. Spacing for several other option descriptions is adjusted; their wording and options are unchanged.

Changes

CLI help text

Layer / File(s) Summary
Update CLI help descriptions
packages/cli/src/main.ts
The --thinking description lists off, minimal, low, medium, high, xhigh, and max. Spacing is adjusted for other option descriptions without changing their wording or listed options.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: haz3-jolt, kaushik-kumar-ceg


Merge Risk: ⚪ Minimal · up to 9fd09

These edits adjust CLI help text, with no demonstrated regression. Confirm the existing credential-free help/version test in the normal checks.

Pre-merge checks | Passed 5 | Failed 1 | Inconclusive 1

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check Warning The description explains the changes and verification, but it does not follow the required template and omits Purpose, Approach, testing commands and results, Checklist, and AI assistance sections. Update the description to use the repository template. Add Purpose, Fixes with issue #423, Approach, How was this tested with commands and results, the required Checklist, and the AI assistance section. State whether the existing help/versi…
Linked Issues check Inconclusive Issue #423 requires aligned help descriptions, accepted thinking levels, and a passing existing credential-free help/version test. The reviewed packages/cli/src/main.ts lists all seven thinking leve… Provide the result of pnpm --filter @axl/cli test, including the --help and --version do not require credentials test.
✅ Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly identifies the CLI help alignment change and the addition of valid --thinking values.
Linked Issues check Passed The description references issue #423, and the reported changes match that issue's alignment and --thinking acceptance criteria.
Out of Scope Changes check Passed The changes are limited to the CLI help string and match the stated objectives. No unrelated changes are reported.
Out of Scope Changes check Passed The available change summary and reviewed source show help-text spacing and --thinking value documentation only. These changes directly implement issue #423. No unrelated behavior or public API chan…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…

Full details: Description check

Resolution

Update the description to use the repository template. Add Purpose, Fixes with issue #423, Approach, How was this tested with commands and results, the required Checklist, and the AI assistance section. State whether the existing help/version credential test was run.


Full details: Linked Issues check

Explanation

Issue #423 requires aligned help descriptions, accepted thinking levels, and a passing existing credential-free help/version test. The reviewed packages/cli/src/main.ts lists all seven thinking levels and aligns the listed option descriptions, including --no-web-search; the two long options remain wider as allowed. The existing test is present in packages/cli/test/unsafe-cli.test.ts, but no test execution result is available. The whole-PR diff could not be fetched because the repository object was unavailable.


  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Line up axl --help option descriptions and list accepted values

1 participant