fix(cli): improve skill command discoverability#10190
Conversation
- Show argument hints in SKILL.md (e.g. `show <component-name>` instead of `show`) - Add ` - ` separator between command name and description - List subcommands below parent commands (e.g. `lane` now shows its 16 subcommands) - Rename CLI_FLAGS.md to CLI_REFERENCE.md to reflect its full content - Replace `--skill flags` with `--skill reference`
There was a problem hiding this comment.
Pull request overview
Improves the generated Claude Code “bit-cli” skill documentation to make Bit CLI commands easier to discover (arguments shown inline, clearer command/description formatting, and surfacing subcommands), while renaming the deep reference doc to better reflect its contents.
Changes:
- Updates the skill command index generation to include argument hints, a
-separator, and visible subcommand lists. - Renames documentation references from
CLI_FLAGS.mdtoCLI_REFERENCE.mdand updates--skillusage fromflags→reference. - Refreshes the contributed
SKILL.mdandCLI_REFERENCE.mdcontent to align with the new naming and structure.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scopes/harmony/cli/generate-doc-md.ts | Adjusts skill command index formatting and updates the reference link to CLI_REFERENCE.md. |
| scopes/harmony/cli/cli.cmd.ts | Changes --skill option from flags to reference and updates help/error messaging accordingly. |
| contrib/claude-skill-bit-cli/SKILL.md | Updates the quick command index content/format to include args and subcommands. |
| contrib/claude-skill-bit-cli/README.md | Updates installation/regeneration instructions to use CLI_REFERENCE.md and --skill reference. |
| contrib/claude-skill-bit-cli/CLI_REFERENCE.md | Updates the detailed reference content (flags/sections) to reflect current CLI output. |
| usage: bit [--version] [--help] <command> [<args>] | ||
|
|
||
| bit documentation: https://bit.dev/ | ||
|
|
||
| System & Utility |
There was a problem hiding this comment.
SKILL.md no longer includes the skill metadata header (e.g., name / description) and title that were previously at the top of the file. Since the README and typical Claude skill formats rely on embedded metadata to identify the skill, dropping it may prevent the skill from being recognized/loaded correctly. Consider restoring the metadata block at the top and keeping the generated command index below it (or updating the generation process to preserve that header).
There was a problem hiding this comment.
Fixed in a subsequent commit — the generator now includes the frontmatter in its output, so piping doesn't strip it.
|
show <component-name>instead ofshow)-separator between command name and descriptionlanenow shows its 16 subcommands)CLI_FLAGS.md→CLI_REFERENCE.mdto reflect its full content (subcommands, args, and flags)--skill flagswith--skill referencein the generate command