Uh oh!
There was an error while loading. Please reload this page.
feat(cli): add --input-json for passing options as JSON - #232
Conversation
🦋 Changeset detectedLatest commit: 42b0a88 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
80caea3 to
82a71cdCompareWarning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 10 minutes and 48 seconds. ⌛ 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. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThis pull request introduces a Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Key areas for review
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
wyattjoh
left a comment
There was a problem hiding this comment.
Think it's possible for us to support stdin as well? That way the agent can just pipe to it.
Expands JSON objects into argv flags before Commander parses them, so any command can receive structured options from AI agents or scripts. Accepts inline JSON or `@path/to/file.json`; camelCase/snake_case keys convert to kebab-case; arrays produce repeated flags; false/null are omitted; nested objects are rejected.
Add stdin support so agents can pipe JSON options directly:
echo '{"framework":"next","yes":true}' | clerk init
Three new input sources:
- `--input-json -` explicitly reads from stdin
- Piped stdin auto-detected when --input-json flag is absent
and stdin is not a TTY
- Existing inline JSON and @file paths remain unchanged
Adds 8 subprocess-based unit tests that exercise both explicit
and auto-detected stdin paths, including error cases.d53462f to
e0ebf01CompareThere was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/cli-core/src/lib/input-json.ts`:
- Around line 122-160: The auto-stdin branch in expandInputJson treats any
non-TTY as piped input and calls readStdin(), which throws when stdin is empty
and breaks CI/background runs; change expandInputJson so that when
hasStdinPipe() is true it calls readStdin() but treats an empty string/EOF as a
no-op (do not throw or mutate argv) — only preserve the current behavior of
erroring when the explicit --input-json value is "-" (the
requireValue/resolveJsonValue path for INPUT_JSON_FLAG must still error on empty
stdin). Implement this by checking the result of readStdin() (or catching its
specific "no json" error) and returning the original argv unchanged when stdin
is empty; keep references: expandInputJson, hasStdinPipe, readStdin,
resolveJsonValue, INPUT_JSON_FLAG.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d00de3eb-c596-40aa-b99d-13e4e0c51885
📒 Files selected for processing (8)
.changeset/input-json-flag.mdREADME.mdpackages/cli-core/src/cli-program.tspackages/cli-core/src/lib/input-json.test.tspackages/cli-core/src/lib/input-json.tspackages/cli-core/src/test/integration/input-json.test.tsskills/clerk/SKILL.mdskills/clerk/references/agent-mode.md
Uh oh!
There was an error while loading. Please reload this page.
Summary
--input-json <json|@file>flag. Keys convert from camelCase/snake_case to kebab-case and expand into argv flags before Commander parses, so any existing flag can come from JSON instead of a shell-escaped string.Behavior
"str"/ number--flag <value>true--flagfalse/null["a","b"]--flag a --flag b(empty arrays omit){…}(nested)invalid_json, exit2Placement. Put
--input-jsonafter the leaf subcommand. Before a subcommand, expanded flags land on the root program, so only root options (--mode,--verbose) work there — subcommand flags like--json/--apperror as unknown. Explicit flags after--input-jsonoverride its values (last-flag-wins).Flags only. Positional arguments (e.g. the
<name>inclerk apps create <name>, the path inclerk api <path>) cannot come from JSON — pass them on the command line as usual.Test plan
bun run format:check,bun run lint,bun run typecheckbun run test— 81 files, all passinglib/input-json.test.ts) cover key conversion, expansion rules,@filereads, error pathstest/integration/input-json.test.ts) coverinit,doctor,api(positional args),apps list,config pull/patch/schema(nested subcommands + array flags), precedence, and placement (both working and erroring cases)clerkminor bumpDocs
--input-jsonsection inskills/clerk/references/agent-mode.md(expansion table, placement rule, error codes).skills/clerk/SKILL.md.README.mdhelp block regenerated.