Repository navigation
fix(cli): organize and clarify command help - #1142
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
soyeon-oai
left a comment
soyeon-oai
left a comment
There was a problem hiding this comment.
Reviewed the help formatter, output-routing boundary, packaging allowlist, and help/schema tests. The formatting gate preserves structured output and command/option rows. No actionable findings. Hosted node-ci passed; I did not independently run tests.
|
@codex review |
|
Codex Review: Didn't find any major issues. Another round soon, please! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Public CSV publication guidance is internally inconsistent, and argument completeness is not actually tested.
Review effort: Balanced
Findings: 2
Open (2)
What changed in this PR
Reorganizes CLI help around common workflows with clearer labels, examples, wrapping, and documentation.
Changes:
- Adds a dedicated help formatter with grouped commands and options.
- Clarifies command descriptions, examples, defaults, and value labels.
- Expands help presentation and package coverage.
| File | Description |
|---|---|
sdk/typescript/src/cli-help.ts |
Formats and groups generated help. |
sdk/typescript/src/cli.ts |
Adds revised help text and examples. |
sdk/typescript/tests-ts/cli-help.test.ts |
Tests formatting, routing, and widths. |
sdk/typescript/tests-ts/cli.test.ts |
Expands command help checks. |
sdk/typescript/tests-ts/cli-skills.test.ts |
Updates semantic value expectations. |
sdk/typescript/tests-ts/cli-scan-import.test.ts |
Updates import file labels. |
sdk/typescript/tests-ts/cli-cloud-publish.test.ts |
Updates CSV label expectation. |
sdk/typescript/scripts/check-package.mjs |
Includes the formatter in package checks. |
sdk/typescript/README.md |
Documents the reorganized help. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f42aaf724c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5f1bccd98a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. Nice work! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Summary
CLI help mixes common commands, advanced settings, and framework options in long lists. Group commands by task and make command help easier to follow with examples, readable value labels, and accurate defaults.
Changes
scanandpublish scanoptions by purpose.Testing
pnpm run types,pnpm run format, andpnpm run build:cipassed.5f1bccdpassed: 3,303 tests passed, 51 skipped, and no failures in each run.ENOSPCwhile copying the native test executable and a SQLite disk I/O error. These runs did not complete; hosted CI must validate the merged commit.Risk and rollout
Human-readable help changes layout and wording. Command syntax, accepted values, defaults, and routing remain compatible; schema descriptions reflect the updated copy. The formatter depends on the pinned Incur help layout, covered by help and packaging tests.
Public disclosure review