Skip to content

fix(cli): document --json for create-json and add-json - #1288

Closed
AmanVarshney01 wants to merge 1 commit into
mainfrom
fix/json-flag-docs
Closed

AmanVarshney01 wants to merge 1 commit into
mainfrom
fix/json-flag-docs

Conversation

@AmanVarshney01

@AmanVarshney01 AmanVarshney01 commented Oct 19, 2026 •

Copy link
Copy Markdown
Owner

Summary

create-json and add-json take their payload through --json. The README, the CLI docs (index.mdx, agent-workflows.mdx) and the site's agent content (agent-content.ts) said --input, which the CLI rejects:

$ create-better-t-stack create-json --input '{...}'
error: unknown option '--input'

Options:
  --json <json>  Input formatted as JSON

Agents following the docs fail on the first call. This replaces the flag in all 12 places. The --input in apps/cli/live-tests/providers.ts belongs to vercel api and is unchanged.

Verification

  • create-better-t-stack create-json --json '{"projectName":"my-app","yes":true,"dryRun":true}' returns "success": true and writes no files.
  • git grep -e "-json --input" returns nothing.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated CLI examples for the create-json and add-json commands to use --json when providing JSON payloads.

The JSON commands take their payload through --json. The README, the CLI
docs and the agent content all said --input, which the CLI rejects with
"unknown option '--input'".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
create-better-t-stack-web Ready Ready Preview Oct 19, 2026 8:30pm UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-19T20:30:39.704913Z c9c53a3 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: afb72773-b092-40c5-abfb-fc8fb7f62fe0
📥 Commits

Reviewing files that changed from the base of the PR and between c90668a and c9c53a3.

📒 Files selected for processing: 4
  • apps/cli/README.md
  • apps/web/content/docs/cli/agent-workflows.mdx
  • apps/web/content/docs/cli/index.mdx
  • apps/web/src/lib/agent-content.ts

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 5 remain after this review.

Walkthrough

The CLI README, web CLI documentation, and agent interface examples now use --json instead of --input for JSON payloads. The payloads remain unchanged.

Changes

CLI JSON examples

Layer / File(s) Summary
Update JSON command examples
apps/cli/README.md, apps/web/content/docs/cli/agent-workflows.mdx, apps/web/content/docs/cli/index.mdx, apps/web/src/lib/agent-content.ts
Examples for create-json and add-json use --json instead of --input.

Priority: ➖ Normal

Merge Risk: ⚪ Minimal · up to c9c53

The examples now use --json for the JSON commands. No actionable merge risk is evident, so this change is ready to merge.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (3 skipped: 3 … Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: documenting --json for the create-json and add-json commands.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (3 skipped: 3 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

  • Fix all pre-merge checks with AI
  • 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.

@AmanVarshney01

Copy link
Copy Markdown
Owner Author

Combined into #1287, which now contains every commit from this PR.

This branch was successfully deployed

1 active deployment
Preview — c9c53a3e Deployed Oct 19, 2026 by vercel[bot]
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