Skip to content

Add comprehensive command documentation to README - #4

Merged
mathieubrunpicard merged 1 commit into
mainfrom
claude/cli-section-api-mcp-j5czm7
Sep 4, 2026
Merged

mathieubrunpicard merged 1 commit into
mainfrom
claude/cli-section-api-mcp-j5czm7

Conversation

@mathieubrunpicard

Copy link
Copy Markdown
Member

Summary

This PR adds auto-generated command documentation to the README.md file, providing users with a complete reference of all available CLI commands, their arguments, flags, and usage examples.

Key Changes

  • Added a new "Commands" section to README.md with a table of contents listing all 34 CLI commands
  • Included detailed documentation for each command including:
    • Command description
    • Usage syntax with all arguments and flags
    • Flag explanations and default values
    • Global flags reference
    • Usage examples where applicable
    • Links to source code
  • Updated package.json scripts to auto-generate documentation:
    • Added docs script that runs oclif readme to generate command documentation
    • Modified prepack script to include npm run docs to ensure documentation is always up-to-date before publishing

Implementation Details

  • Documentation is generated from command class definitions using oclif's built-in documentation generator
  • The generated section is marked with HTML comments (<!-- commands --> and <!-- commandsstop -->) to allow for safe regeneration
  • All commands are documented with consistent formatting including usage patterns, flags, descriptions, and examples
  • Documentation includes links to source code files with version reference (v0.1.3)

https://claude.ai/code/session_018KocZzBsaC3JNDSFU2QvD6

The README showed a handful of hand-picked examples, so the only way to
discover the other two dozen commands and their flags was `--help` on a
guess. Add a Commands section generated by `oclif readme` from the
command classes, and run it from `prepack` so a publish cannot ship a
reference that has drifted from the code.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018KocZzBsaC3JNDSFU2QvD6
@mathieubrunpicard
mathieubrunpicard merged commit b07e12b into main Sep 4, 2026
2 checks passed
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