Getting started

Install rig, set the runtime URL, pull an agent image, then create a named session. The relay at rig-runtime.slopkit.dev is one runtime. You can run your own.

Get the CLI

Linux x86_64. Writes ~/.local/bin/rig from the latest GitLab package.

curl -fsSL https://rig.slopkit.dev/install.sh | bash

Pin a package version with RIG_VERSION. From a checkout of the product repo, bun install then bun run rig -- help.

Point at a runtime

Local session create starts a background supervisor if none is running. For the hosted relay, pass the URL and a token.

export RIG_RUNTIME_URL=https://rig-runtime.slopkit.dev
export RIG_RUNTIME_TOKEN=…

Or rig session create --supervisor https://rig-runtime.slopkit.dev ….

Pull an agent

HTTPS image refs are the card URLs. Bare name@tag walks repositories in ~/.config/rig/config.toml.

rig pull https://repo.slopkit.dev/agents/deepwriter@latest
rig pull deepwriter@latest

Create a session

Default name is the agent name. Pick a workdir. Host bind, git clone, or a persistent volume on the runtime.

rig session create --agent deepwriter --workdir-host "$PWD" --prompt "hello"
# rig session create --agent deepwriter --workdir-clone https://example.com/project.git
# rig session create --agent deepwriter --workdir-persistent notes

Shell or attach

rig shell is an interactive bash in the session root. rig attach is the harness TTY. Both talk to the supervisor. They do not bwrap relay paths on your laptop.

rig shell deepwriter
rig attach deepwriter