docs: CLI page accuracy pass#169
Conversation
Brings cli.mdx in line with what's actually shipped in @recoupable/cli v0.1.13. Removed: - Entire `## research` section (~100 lines of fictional examples). No `recoup research` command exists in source — it was aspirational documentation that would have caused agents to retry "command not found" loops. - `recoup content image / video / caption / transcribe / upscale / analyze / edit` subcommands. Only `templates`, `validate`, `estimate`, and `create` exist in the published CLI; the rest were documented but unimplemented. - Misleading "legacy pipeline" framing inside the content section that pointed agents at non-existent subcommands as the modern path. Added: - The real `songs` command (`presets`, `analyze`) which had been shipped in v0.1.13 but never documented. - A `<Note>` at the top stating the CLI is in beta, listing what actually works, and instructing agents to fall back to the REST API for anything not in the documented command surface. Verified by running `ls cli/src/commands/` against every command documented here. Made-with: Cursor
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="cli.mdx">
<violation number="1" location="cli.mdx:137">
P2: `--audio` is documented as required for `recoup songs analyze`, but the shipped CLI/API contract treats it as optional/conditional.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
cli/src/commands/songs.ts uses .option("--audio <url>"), not
.requiredOption(...), and the action handler only includes
body.audio_url when provided. The action's only required-field
check is that EITHER --prompt OR --preset must be supplied.
The OpenAPI spec for POST /api/songs/analyze has an empty
`required: []` array.
Update the flag table to reflect the real contract:
--preset Conditional (required when --prompt is omitted)
--prompt Conditional (required when --preset is omitted)
--audio No — some presets (e.g. catalog_metadata) work
from metadata alone, others use the audio file
--max-tokens No
Caught by cubic-dev-ai on PR #169.
Made-with: Cursor
3 participants
Summary
Brings
cli.mdxin line with what's actually shipped in@recoupable/cliv0.1.13. Removes fictional commands, adds real ones, marks the page as beta.Why this matters
Agents (and humans) following the docs should not hit
command not found. The previouscli.mdxdocumented arecoup researchcommand and severalcontent/*subcommands that don't exist in the published binary. An LLM agent reading those docs would install the CLI, try to run them, fail, and either retry forever or give up.Changes
Removed:
## researchsection (~100 lines of fictional examples). Norecoup researchcommand exists incli/src/commands/.recoup content image/video/caption/transcribe/upscale/analyze/editsubcommands. Onlytemplates,validate,estimate,createexist.Added:
songscommand (presets,analyze) — shipped in v0.1.13 but undocumented.<Note>at the top declaring beta status, listing implemented commands, and telling agents to fall back to REST when something isn't documented.Verification
Every command documented in this PR was verified by running
ls cli/src/commands/against the source.Stack
PR 2 of 7. Replaces #145.
Test plan
cli.mdxrun successfully againstnpm i -g @recoupable/cli@0.1.13<Note>block renders correctly in MintlifyMade with Cursor
Summary by CodeRabbit