Get started

Quickstart

If you use Pi already, Pi-Bolt works with what you have: run pi-bolt instead of pi. If you are new to Pi, this page takes you from install to a first finished task.

Install Pi-Bolt

$ curl -fsSL https://pi-bolt.opensec.in/install.sh | sh

On Windows or with npm, see Installation.

Start it in a project
```
$ cd my-project
$ pi-bolt
```
Pi-Bolt opens Pi's terminal interface in the current folder. That folder is what the agent reads and edits.
Connect a model
If you have used Pi, your providers and logins are already there. Otherwise type /login and pick a provider, or set a provider's API key in your environment (for example ANTHROPIC_API_KEY or OPENAI_API_KEY) before starting. Switch models with /model. See Pi's Choose a model.
Give it a task
Type what you want done and press Enter, for example Find where the config file is parsed and add a test for an empty file. The agent reads files, runs commands and edits code, and shows each step as it goes. Press Escape to stop it.

Common commands#

$ pi-bolt "Explain the build setup"       # start with a prompt
$ pi-bolt -p "List the TODOs in src/"     # run one prompt, print the answer, exit
$ pi-bolt -c                              # continue the last session here
$ pi-bolt -r                              # pick a session to resume
$ pi-bolt --model sonnet:high             # a model, with a thinking level
$ pi-bolt @README.md "Summarize this"     # include a file

pi-bolt --help lists every option. They are Pi's options; Pi's CLI reference describes them in full.

Using Pi-Bolt next to Pi#

Pi-Bolt and Pi share ~/.pi/agent, so both see the same:

providers, logins and API keys (auth.json, models.json);
settings (settings.json);
sessions, which either can resume;
extensions, skills, prompt templates and themes.

Install an extension with either command and both load it:

$ pi-bolt install npm:opensec-pi-todo

A tool that starts Pi by running pi keeps using stock Pi. To make it use Pi-Bolt, point it at pi-bolt: see Integrations.

Next steps#

Choose a buildWhen to use the JIT build instead of the default. ExtensionsHow extensions run in Pi-Bolt, and which need the JIT build. Use Pi in the terminalPi's guide to the interface, commands and shortcuts. SessionsResume, branch and export your work, in Pi's docs.