Getting Started
Install
Section titled “Install”One line on Windows (PowerShell):
irm https://raw.githubusercontent.com/lacodda/rigger/main/tools/install.ps1 | iexOne line on macOS / Linux:
curl -fsSL https://raw.githubusercontent.com/lacodda/rigger/main/tools/install.sh | shVia npm:
npm i -g @lacodda/riggerVia cargo:
cargo install riggerOr download the archive for your platform from Releases (Windows x86_64, Linux x86_64, macOS arm64), unpack and put rigger on your PATH.
The short name
Section titled “The short name”Every installer leaves rgr beside rigger: the same program, half the typing.
> rgr --versionrigger 0.9.0It is a link, not a second copy - a hard link on Windows, a symlink elsewhere - so one set of bytes answers to both names and rgr can never report a version rigger has moved past.
If rgr already means something else on your machine, the installer says so and leaves it alone; RIGGER_NO_ALIAS=1 skips it outright. cargo install rigger installs rigger only, since cargo builds what the manifest declares and the manifest deliberately declares one binary.
The name is rgr rather than rr, which would have matched the mark: rr is Mozilla’s record-and-replay debugger, packaged in every Linux distribution.
Installer options
Section titled “Installer options”Both scripts read these environment variables:
| Variable | Effect |
|---|---|
RIGGER_VERSION |
Install this tag (e.g. v0.1.0) instead of the newest release |
RIGGER_INSTALL_DIR |
Where the binary lands; defaults to %LOCALAPPDATA%\Programs\rigger on Windows and ~/.local/bin elsewhere |
RIGGER_NO_ALIAS |
Set to 1 to skip the rgr alias |
First run
Section titled “First run”$ rigger initCreated C:\Users\you\AppData\Local\lacodda\rigger\data\rigger.db (schema version 4)Next: rigger project add <path>The database lives in the platform’s local data directory; RIGGER_DATA_DIR overrides it, and rigger doctor prints the path in use.
Record a project
Section titled “Record a project”Point rigger at a repository. The project is named after its directory; --name overrides.
$ rigger project add C:\dev\sampleRecorded 'sample' at C:\dev\sample remote: https://github.com/acme/sample.git
$ rigger project listsample C:\dev\sampleA whole directory of repositories, with their hubs and tags, is one command: rigger adopt.
Check the state
Section titled “Check the state”$ rigger doctordatabase: C:\Users\you\AppData\Local\lacodda\rigger\data\rigger.dbschema: version 4projects: 1versions: 0tasks: 0sessions: 0events: 0Connect your assistant
Section titled “Connect your assistant”The record is worth keeping only if it is written as the work happens. Connect the MCP server, and an assistant reads the packet and records what it decides through tools, instead of leaving it in a transcript:
$ claude mcp add rigger -- rigger mcpAdded stdio MCP server rigger with command: rigger mcp to local configNext steps
Section titled “Next steps”- Read the model: projects, versions, tasks, sessions and events.
- See how the context packet replaces reading a hub.
- Understand profiles: one binary at home and at work.