Add gh-style --json CLI mode for LLM agents - #28
Closed
rafaeelricco wants to merge 1 commit into
Closed
Conversation
Introduce machine-readable output for generate and doctor commands with explicit action flags (--commit, --push, --adjust, --dry-run, --yes). Interactive Clack flow remains the default when --json is not set. Co-authored-by: Rafael Ricco <rafaeelricco@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds machine-readable
--jsonoutput forcommit generateandcommit doctor, following the same pattern asgh. When--jsonis set, the CLI skips Clack prompts and writes structured JSON to stdout; errors go to stderr as JSON.Automation flags (require
--json):--adjust <text>— refine the message once--dry-run— generate only, no git writes--commit— commit with the generated message--push— push after commit--yes— publish branch or force-with-lease without confirmInteractive
commit/commit generatebehavior is unchanged.Changes
src/cli/json-io.ts— JSON schemas,CliErrorcodes, stdout/stderr writerssrc/cli/generate-flags.ts—GenerateRunModeunion and flag parsingsrc/cli/parser.ts— flag-aware command parsing and help textsrc/cli/commit.ts—run(mode)withrunJson/pushJsonpathssrc/cli/doctor.ts—doctor --jsonwith checks arrayindex.ts— passescommand.mode/command.json(thin switch unchanged)AGENTS.md+ README agent sectionExample usage
Verification
pnpm run typecheckpnpm run lint:cipnpm test(78 passed)pnpm run build