Repository navigation
docs: cover shipped CLI command groups and guard README drift - #31
Merged
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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
--helpwith 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 lintcannot 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, andtaskscommand groups that were missing from the README, and adds a test comparing the built CLI's--helpoutput against the README examples so a newly registered group can't silently disappear from the reference.Details
--helpwith an empty environment and failed on current main before the README repair.Written for commit 8efcafb. Summary will update on new commits.