Reference
Manifest schema
Compact rig.toml reference. One table per section, every field, every default.
For prose and examples, see Manifest reference. This page
is just the schema.
| Field | Type | Required | Default |
|---|
name | string | yes | — |
author | string | yes | — |
version | string (semver) | yes | — |
description | string | yes | — |
runtime | string (only "claude-code") | yes | — |
Details.
| Field | Type | Default |
|---|
include | list of glob strings | (built-in defaults; see package) |
exclude | list of glob strings | (built-in defaults) |
Defaults documented in [package].
| Field | Type | Default |
|---|
required | list of strings | [] |
optional | list of strings | [] |
template | string (file path) | none |
target | string (file path) | .env |
Details.
| Field | Type | Default |
|---|
required | list of strings (CLI names) | [] |
Details.
| Field | Type | Default |
|---|
config | string (file path) | .mcp.json |
servers | list of strings | [] |
Details.
| Field | Type | Default |
|---|
required | list of strings | [] |
Advisory. Details.
| Field | Type | Default |
|---|
allow | list of Claude permission patterns | [] |
deny | list of Claude permission patterns | [] |
Deny always wins on merge with .claude/settings.json.
Details.
| Field | Type | Default |
|---|
dirs | list of folder paths | [] |
Listed dirs are created on install with .rigkeep, never shipped. Stronger than [package].include.
Details.
| Field | Type | Default |
|---|
commands | list of shell strings | [] |
Run only with --run-hooks or interactive confirmation.
Details.
| Field | Type | Default |
|---|
entrypoint | string | none |
instructions | string (supports {install_dir}) | none |
Documentation-only. Rig does not execute.
Details.
| Field | Type | Required when section present | Default |
|---|
provider | string (only "tap") | yes | — |
relay | string (URL) | yes | — |
enabled | boolean | no | true |
name | string (binding name) | no | [rig].name |
Presence of the section opts the rig into collaboration.
Details.
| Error | Cause |
|---|
[rig] section is required | Missing [rig]. |
[rig].<field> is required | A required [rig] field is missing or empty. |
[rig].version is not valid semver | Bad version string. |
[rig].runtime must be "claude-code" | Other runtimes not supported. |
Manifest is not valid TOML | Syntax error. |