Skip to content

docs: cover shipped CLI command groups and guard README drift - #31

Merged
sidneyswift merged 1 commit into
mainfrom
codex/readme-command-coverage
Oct 31, 2026
Merged

sidneyswift merged 1 commit into
mainfrom
codex/readme-command-coverage

Conversation

@sidneyswift

@sidneyswift sidneyswift commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

The shipped CLI registers songs, emails, tasks and content, but its README omitted all four command groups. Add examples for the existing commands and explain the required audio/analysis mode, optional email subject, estimate-versus-create behavior and task run IDs. Keep installed-package availability separate from checkout documentation.

A focused guard compares compiled CLI help with README examples, so a newly registered group cannot silently disappear from the reference. It runs only --help with an empty environment. The test failed on current main with precisely those four omissions before the README repair.

Validation: build, TypeScript and all 84 tests pass; independent source review reports no actionable findings. pnpm lint cannot run because ESLint is absent from the repository dependencies (eslint: command not found). No runtime command behavior or package version changed. This guards group coverage, not every example's HTTP payload or npm installation.

Refs recoupable/mono#355 and recoupable/mono#360. The open full API parity PR #23 remains separate; no unreleased commands from that PR were copied. Npm publication/credentials and installed-host acceptance remain with their existing owners.


Summary by cubic

Documents the songs, emails, content, and tasks command groups that were missing from the README, and adds a test comparing the built CLI's --help output against the README examples so a newly registered group can't silently disappear from the reference.

Details

  • The examples cover the required audio/analysis mode, optional email subject, estimate-versus-create behavior, and task run IDs.
  • The guard runs only --help with an empty environment and failed on current main before the README repair.
  • No runtime command behavior or package version changed.

Written for commit 8efcafb. Summary will update on new commits.

View guided diff Turn on auto-fix

@coderabbitai

coderabbitai Bot commented Oct 31, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1ba8e685-f108-4cd7-9278-a4be1f437126
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@sidneyswift
sidneyswift merged commit d9594d7 into main Oct 31, 2026
3 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.

1 participant