Use a rig
Install a rig
rig hub use — fetch, verify, extract.
rig hub use <source>Examples:
rig hub use hub:maria/market-researcher
rig hub use hub:maria/market-researcher@1.2.0
rig hub use github:acme/agents-research
rig hub use ./downloads/market-researcher-1.0.0.rig.tgz
rig hub use registry:maria/market-researcherThe full grammar is on Source specifiers.
What it does
- Resolve — work out where the artifact lives based on the source prefix.
- Download — fetch the
.rig.tgzto a temp file. For Hub installs, the CLI readsX-Rig-SHA256from the response and verifies the hash. - Inspect — open the tarball, read
rig.toml, validate the manifest. - Extract — write files into the target directory.
- Record — write
.rig/instance.tomlwith the source ref and install time sorig hub updateknows where this came from.
What it doesn't do: install MCP servers, write env values, run shell
hooks, or grant permissions. Those happen in the separate
rig install step so they're explicit.
Flags
| Flag | What |
|---|---|
--dir <path> | Install into a specific directory. Defaults to ./<name> in cwd. |
--force | Overwrite an existing target directory. Otherwise refuses if non-empty. |
--json | Emit a machine-readable summary. |
--plain | Suppress fancy prompts/spinners (good for scripts). |
After install
cd <name>
rig install # set up env, dirs, permissions
rig doctor # confirm readinessrig install is split out because it's the side-effecting step — see
Run setup for the full picture.
Sandboxed test installs
To try a rig without polluting your workspace:
rig hub use hub:author/name --dir /tmp/test-rig
cd /tmp/test-rig && rig install && rig doctorNothing in /tmp survives a reboot, so this is a clean way to evaluate before
committing.
See also
- Inspect before installing — read the manifest without extracting.
- Source specifiers — every supported source.
- Update — pull a newer version while keeping your local state.