Skip to content

feat(cli): add help command - #33

Merged
Kikobeats merged 1 commit into
masterfrom
feat/cli-help
Sep 8, 2026
Merged

feat(cli): add help command#33
Kikobeats merged 1 commit into
masterfrom
feat/cli-help

Conversation

@Kikobeats

@Kikobeats Kikobeats commented Sep 8, 2026

Copy link
Copy Markdown
Member

Summary

  • Add microlink help as a first-class CLI command with the same output as microlink --help
  • microlink help <product> matches microlink <product> --help

Test plan

  • microlink help equals microlink --help
  • microlink help screenshot equals microlink screenshot --help
  • Existing CLI help tests still pass in CI

Made with Cursor

Summary by CodeRabbit

  • New Features
    • Added a help command to display general CLI guidance.
    • Added support for scoped help, such as help <product>, to show product-specific usage information.
    • The help command now provides the same guidance as the corresponding --help options.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview 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: a28f3604-37fe-49ab-a2db-df0c863fe509

📥 Commits

Reviewing files that changed from the base of the PR and between 6d33b93 and 4da8b54.

📒 Files selected for processing (3)
  • packages/core/bin/help.js
  • packages/core/bin/run.js
  • packages/core/test/cli.mjs

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The CLI now supports help and help <command> forms. Both forms route through showHelp, and tests verify output matches the existing --help forms.

Changes

CLI Help Command

Layer / File(s) Summary
Help command definition
packages/core/bin/help.js
The command registry and global help text now document help [command] with examples.
Help command dispatch and validation
packages/core/bin/run.js, packages/core/test/cli.mjs
The CLI passes an optional target to showHelp. Tests compare general and command-specific help output with the existing --help forms.

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

Merge Risk: ⚪ Minimal · up to 4da8b

The CLI now supports microlink help and microlink help <product> with output matching existing help flags. No current merge-blocking risk is identified.

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant run.js
  participant showHelp
  CLI->>run.js: invoke help [target]
  run.js->>showHelp: showHelp(target)
  showHelp-->>CLI: render scoped help output
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the main change: adding a CLI help command.
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 3…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/cli-help

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.

@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 34197054688

Warning

No base build found for commit 6d33b93 on master.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 77.971%

Details

  • Patch coverage: 12 of 12 lines across 2 files are fully covered (100%).

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 4884
Covered Lines: 3813
Line Coverage: 78.07%
Relevant Branches: 822
Covered Branches: 636
Branch Coverage: 77.37%
Branches in Coverage %: Yes
Coverage Strength: 24.15 hits per line

💛 - Coveralls

@Kikobeats
Kikobeats merged commit d673f8e into master Sep 8, 2026
9 checks passed
@Kikobeats
Kikobeats deleted the feat/cli-help branch September 8, 2026 07:31
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.

2 participants