docs: add CLI content command documentation#61
Conversation
Documents the new recoup content command suite: templates, validate, estimate, create, and status subcommands with flags and examples. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Warning Rate limit exceeded
⌛ 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. 📝 WalkthroughWalkthroughAdded comprehensive documentation for the new "content" command to sdk.mdx, including usage examples, command flags, and references to related API endpoints for content creation pipeline operations. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
sdk.mdx (1)
122-125: Use consistent placeholder names for flags across examples and tables.Examples use
<artistAccountId>/<runId>, while tables use<id>. Standardizing these improves scan speed and reduces ambiguity.Suggested doc patch
-| `--artist <id>` | Yes | Artist account ID | +| `--artist <artistAccountId>` | Yes | Artist account ID | ... -| `--artist <id>` | Yes | Artist account ID | +| `--artist <artistAccountId>` | Yes | Artist account ID | ... -| `--run <id>` | Yes | Trigger.dev run ID | +| `--run <runId>` | Yes | Trigger.dev run ID |As per coding guidelines "Keep documentation content concise and scannable".
Also applies to: 155-156, 171-173
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@sdk.mdx` around lines 122 - 125, The table uses generic `<id>` but examples use `<artistAccountId>` and `<runId>`; update the flag placeholder names in the table rows for the `--artist` and related run flags to use the same placeholders as the examples (e.g., replace `<id>` with `<artistAccountId>` for `--artist`, and with `<runId>` for run-related flags) so all examples and tables consistently use the same placeholder naming across the sdk.mdx document.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@sdk.mdx`:
- Around line 100-103: Add a short availability/version callout under the
"Content-creation pipeline commands" section referencing the CLI command group
"recoup content": state the minimum CLI version that includes these commands (or
mark as "coming soon" if not yet released) so users on the current npm release
won't hit unknown-command errors; place the note directly beneath the "##
content" heading and format it as a brief admonition mentioning "recoup content"
and the exact minimum version string (or "coming soon") to make intent and
upgrade action clear.
---
Nitpick comments:
In `@sdk.mdx`:
- Around line 122-125: The table uses generic `<id>` but examples use
`<artistAccountId>` and `<runId>`; update the flag placeholder names in the
table rows for the `--artist` and related run flags to use the same placeholders
as the examples (e.g., replace `<id>` with `<artistAccountId>` for `--artist`,
and with `<runId>` for run-related flags) so all examples and tables
consistently use the same placeholder naming across the sdk.mdx document.
Run status is a general tasks concept, not content-specific. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Rename sdk.mdx → cli.mdx with /cli route - Update docs.json navigation reference - Re-add content section (templates, validate, estimate, create) after tasks Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Aligns CLI docs with the API reference which uses artist_account_id. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
recoup contentcommand suite in the CLI reference page (sdk.mdx)templates,validate,estimate,create,statusContext
Precursor to CLI PR recoupable/cli#13 which adds these commands.
🤖 Generated with Claude Code
Summary by CodeRabbit