Skip to content

Latest commit

 

History

History

rig-cli

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

rig-cli

The library of the rig command, the launcher of the rig coding agent, a terminal coding agent built on rig-harness.

cargo install rig installs the command; the rig crate's binary calls this crate. cargo install rig-cli installs no binary. The agent guide says how to install it.

To update, run rig update (/update in the agent): it reinstalls rig from where it came from, crates.io or the checkout as it is now (git pull first is yours), printing the cargo command first, and builds the agent at the new version. It also replaces a launcher an older rig-cli installed. /update then resumes the session on it.

It generates a small Cargo project for the agent under RIG_HOME (default ~/.rig) with the plugins RIG_HOME/settings.toml turns on, builds it, and runs it. settings.toml is the one file you edit: its [plugins] table holds only your changes to rig's built-in list (enable, disable, the branches of the plugin tree in off, such as rig-basics/sessions, and [[plugins.extra]] crates). Turning a plugin on or off rebuilds the agent at the next start: only the generated crate compiles again, and a plugin's own crate the first time it is on.

rig help lists the commands, rig plugin --help the plugin commands, and rig help-agents how a script drives rig headless. The agent guide describes using it, from the quick start on.