Skip to content

docs: add CLI content command documentation#61

Merged
sweetmantech merged 6 commits intomainfrom
feat/cli-content-commands
Mar 13, 2026
Merged

docs: add CLI content command documentation#61
sweetmantech merged 6 commits intomainfrom
feat/cli-content-commands

Conversation

@sweetmantech
Copy link
Copy Markdown
Collaborator

@sweetmantech sweetmantech commented Mar 12, 2026

Summary

  • Documents the new recoup content command suite in the CLI reference page (sdk.mdx)
  • Covers all 5 subcommands: templates, validate, estimate, create, status
  • Includes flags, defaults, and links to corresponding API reference endpoints
  • Follows existing CLI doc patterns (whoami, orgs, artists, etc.)

Context

Precursor to CLI PR recoupable/cli#13 which adds these commands.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the new content-creation pipeline commands, covering template listing, artist readiness validation, cost estimation, content creation, and run status monitoring.
    • Included detailed flags reference table and links to related API endpoints.

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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 12, 2026

Warning

Rate limit exceeded

@sweetmantech has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 13 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 414fd6d7-8a9a-4d46-be43-f1899f1e9c4e

📥 Commits

Reviewing files that changed from the base of the PR and between 443dca4 and 2010b70.

📒 Files selected for processing (2)
  • cli.mdx
  • docs.json
📝 Walkthrough

Walkthrough

Added 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

Cohort / File(s) Summary
Documentation: Content Command
sdk.mdx
Added detailed section covering content command functionality with subsections for list templates, validate artist readiness, estimate cost, create content, and check run status. Includes command examples, required/optional flags table, and API endpoint references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 In documentation's garden where commands do grow,
New content commands steal the show,
With templates and flags, a pipeline so neat,
This SDK guide makes the feature complete!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add CLI content command documentation' clearly and concisely summarizes the main change—adding documentation for the new CLI content commands to sdk.mdx.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/cli-content-commands
📝 Coding Plan
  • Generate coding plan for human review comments

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 06714b99-55fc-4426-8941-6f876701cd20

📥 Commits

Reviewing files that changed from the base of the PR and between 0c74a3f and 443dca4.

📒 Files selected for processing (1)
  • sdk.mdx

sweetmantech and others added 5 commits March 12, 2026 19:00
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>
@sweetmantech sweetmantech merged commit 0445501 into main Mar 13, 2026
1 check passed
@sweetmantech sweetmantech deleted the feat/cli-content-commands branch March 13, 2026 00:08
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