Skip to content

Add REFERENCE.md with auto-generated CLI help documentation - #361

Merged
jancurn merged 1 commit into
mainfrom
claude/reference-md-auto-help-23bpyr
Aug 2, 2026
Merged

Add REFERENCE.md with auto-generated CLI help documentation#361
jancurn merged 1 commit into
mainfrom
claude/reference-md-auto-help-23bpyr

Conversation

@jancurn

@jancurn jancurn commented Aug 2, 2026

Copy link
Copy Markdown
Member

Adds REFERENCE.md: the --help output of every command, in the order mcpc --help lists them. It's captured from the built CLI by scripts/generate-reference.mjs, the same way the Usage block in README.md is, so it can't drift into hand-written prose.

  • pnpm run build:reference regenerates it, pnpm run check:reference fails when it no longer matches the CLI
  • CI runs the check; the release workflow regenerates and commits it next to README.md
  • Command names and order are parsed out of mcpc --help itself — nothing hardcoded — and commands the overview omits (the session-level close/restart screens) are still included
  • Generated with colors off and a throwaway MCPC_HOME_DIR, and without the version-pinned Full docs: line, so the output is deterministic
  • README, CONTRIBUTING and CLAUDE.md point at the new file and the regenerate step

No originating issue — requested directly; happy to open one if you'd like a tracking artifact.

https://claude.ai/code/session_01TwS6auWuztE5mdLGuDqNy9

REFERENCE.md collects the `--help` output of every mcpc command, in the order
the commands are listed by `mcpc --help`. It is captured from the built CLI by
scripts/generate-reference.mjs, the same way the Usage block in README.md is,
so it can never drift into hand-written prose.

- `pnpm run build:reference` regenerates it; `pnpm run check:reference` fails
  when the committed file no longer matches the CLI
- CI runs the check, and the release workflow regenerates and commits the file
  alongside README.md
- Command order follows `mcpc --help`; anything the overview does not list
  (e.g. the session-level `close`/`restart` screens) is still included

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TwS6auWuztE5mdLGuDqNy9
@jancurn
jancurn merged commit 36e371a into main Aug 2, 2026
7 checks passed
@jancurn
jancurn deleted the claude/reference-md-auto-help-23bpyr branch August 2, 2026 11:14
jancurn pushed a commit that referenced this pull request Aug 2, 2026
Refs #361

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HYhygKZPPuddYpG67y7c1N
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.

3 participants