Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
Description
This PR adds an automated GitHub Actions workflow that validates README.md accuracy against the CLI implementation. The workflow uses Claude Code Action to verify that all non-hidden commands are documented with matching descriptions, installation instructions reference correct package metadata, and quick start examples use valid commands. When discrepancies are found, it automatically updates README.md and commits the changes back to the PR branch.
Related Issue
None
Type of Change
Changes Made
.github/workflows/readme-check.ymlworkflow that triggers on PR events when CLI source code, package.json, or README.md changesanthropics/claude-code-action@v1to analyze command registrations insrc/cli/program.tsand command factory filespackage.jsonmetadata (package name, Node version requirement)claude_args: only allows Read, Glob, Grep, Write, and specific Bash commands (git config/add/commit/push, gh pr comment)Testing
bun test)Checklist
Additional Notes
Requires
CLAUDE_CODE_OAUTH_TOKENsecret configured in repository settings. The workflow has write permissions to contents and pull-requests to enable automatic fixes and PR comments. Theallowed_botsparameter includesclaude[bot]to allow Claude bot status updates. This automation helps maintain documentation accuracy as the CLI evolves without requiring manual README updates after code changes.🤖 Generated by Claude | 2026-02-11 14:42 UTC