gritHEAD → docs/schemas
The grit CLI / JSON schemasMarkdown

JSON schemas

Versioned v1 JSON Schemas for every grit command's --json success object.

Every command that prints a JSON outcome object with --json has a versioned JSON Schema served at a stable URL (https://grit-scm.com/schemas/<command>/vN.json). Most commands are still on v1; clone publishes v3 while v1 and v2 remain frozen; config, merge, mv, pull, pick, remote (and several remote.* subcommands), switch, tag, and worktree.prune publish v2 while v1 remains frozen for older clients.

See the Agent guide for additive vs breaking rules, the CI backward-compatibility gate, and how to regenerate live files under content/schemas/ with GRIT_UPDATE_SCHEMAS=1.

Plain command failures with --json validate against the shared error schema.

Command schemas

Command path Schema
add v2, v1
auth v1
auth.logout v1
blame v1
branch v1
bundle.create v1
bundle.list v1
bundle.unbundle v1
bundle.verify v1
cat v1
clean v1
clone v3, v2, v1
commit v1
config v2, v1
diff v1
error v1
fetch v1
fetch.all v1
fsck v1
gc v1
gc.commit-graph v1
gc.drop-large-blobs v1
gc.midx v1
gc.pack-refs v1
gc.offload v1
gc.prune v1
gc.repack v1
history.absorb v1
history.drop v1
history.fixup v1
history.move v1
history.rebase v1
history.reword v1
history.split v1
history.squash v1
history.undo v1
hooks v1
hooks.list v1
hooks.run v1
ignore.check v1
init v1
log v1
merge v2, v1
merge-base v1
mv v2, v1
notes v1
notes.add v1
notes.list v1
notes.remove v1
notes.show v1
patch-id v1
pick v2, v1
history.move v1
history.reword v1
history.fixup v1
history.absorb v1
pull v2, v1
push v1
rebase v1
rebase.check v1
reflog v1
reflog.list v1
reflog.delete v1
reflog.expire v1
remote v2, v1
remote.add v2, v1
remote.prune v1
remote.refs v2, v1
remote.remove v2, v1
remote.rename v2, v1
remote.set-head v1
remote.set-url v2, v1
remote.show v2, v1
repack v1
reset v1
resolve v1
restore v1
revert v1
revs v1
rm v1
shortlog v1
show v1
skill v1
stash v1
stash.apply v2, v1
stash.branch v2, v1
stash.drop v2, v1
stash.list v2, v1
stash.pop v1
stash.push v1
stash.show v1
stash.clear v1
status v1
switch v2, v1
tag v2, v1
update v1
worktree.add v1
worktree.list v1
worktree.lock v1
worktree.move v1
worktree.prune v2, v1
worktree.remove v1
worktree.repair v1
worktree.unlock v1

Plumbing commands (manager, upload-pack, receive-pack) and shell completion generation do not emit JSON outcome objects and have no schemas here.

See also

Scripting with grit, Agent guide