# 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](https://grit-scm.com/docs/agents/index.md#json-schema-versioning) 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](https://grit-scm.com/docs/schemas/schemas/error/v1.json/index.md).

## Command schemas

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

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](https://grit-scm.com/docs/scripting/index.md), [Agent guide](https://grit-scm.com/docs/agents/index.md)
