rig CLI
A fast, opinionated scaffolder for code projects. Install it, run a template, and get back to work.
Install rigInstallation
Install rig
Copy and run the command for your platform. rig requires Node.js 20 or newer.
macOS / Linux
npm install -g rig-cliWindows
npm install -g rig-cliVerify the install:
rig --versionQuick start
Quick start
Create a project from a template in three commands.
1. Initialize a new project in the current directory:
rig init2. Pick a template when prompted:
? Select a template: (Use arrow keys)3. Install dependencies and start the dev server:
npm installnpm run dev
All templates include a README with next steps.
Command reference
Command reference
Every rig command, its options, and an example.
| Command | Description | Example |
|---|---|---|
| rig init | Create a new project from a template in the current directory. | rig init --template node-server |
| rig list | List available templates and their descriptions. | rig list |
| rig create <name> | Create a new project in a subdirectory called <name>. | rig create my-api |
| rig version | Print the installed version. | rig version |
| rig help [command] | Show help for a command, or general help if omitted. | rig help create |