Peridot CLI

Peridot in your terminal: commands, shortcuts, approvals and settings.

The Peridot CLI is the same coding agent as in the desktop app, in your terminal. You start it, chat, and everything else is a slash command.

Note

AI teams are a desktop feature. The CLI runs a single agent.

Install and start#

Download the binary for your system from the download page, put it on your PATH and run:

bash

peridot

The conversation scrolls above. The input sits at the bottom between two rules, with your account and the current model on the status line. Messages you send are shown on a slightly lighter background.

Sign in once with /login. Peridot opens your browser for Email (on the Peridot website) or Google, and listens on 127.0.0.1 for the result. Without signing in, the CLI is chat only.

Working in your project#

The folder you start peridot in is the workspace. Signed in, Peridot can list, read and search files there, create and edit them, and run shell commands, all confined to that folder. Paths outside it, also through symlinks, are refused.

Warning

Starting Peridot in your home folder or in / makes the workspace very broad. The CLI warns you. Start it inside a project instead.

It uses the same tools and limits as the desktop app. See Tools and approvals.

Approval modes#

Manual (default): before it writes a file, edits one or runs a command, a window shows exactly what it is about to do and asks. Choosing "Yes, and don't ask again" switches to auto approval.
Auto approval: it does everything without asking.

Shift + Tab cycles between the two. The current mode is shown under the input.

Commands#

Command	What it does
`/model [name\|number]`	Show or change the model.
`/usage`	A window with plan limits, a token heatmap of the last year and usage per model. `Tab` switches between larger cells and the whole year.
`/login`	Sign in with Email or Google, both in your browser.
`/logout`, `/whoami`	Sign out, or show who you are.
`/resume`	Continue an earlier conversation.
`/clear`	Start a new conversation.
`/plugin [list\|search\|install\|uninstall\|installed]`	Browse and install plugins. See Plugins.
`/help`	List the commands.
`/exit`	Quit.

Commands from your installed plugins appear as /name too.

Keyboard#

Keys	Action
`Enter`	Send the message.
`/`	Start a command. The rest of the name appears in grey: Tab or → accepts it.
`↑` / `↓`	Recall earlier messages.
`Shift + Tab`	Switch between Manual and Auto approval.
`Ctrl + C`	Stop the response, and any command that is still running.
`!command`	Run a shell command in the workspace yourself, for example `!git status`.

Settings and environment#

The token and the selected model are stored in ~/.config/peridot/config.json (readable only by you). Plugins live in ~/.config/peridot/plugins, shared with the desktop app.

Variable	Meaning
`PERIDOT_TOKEN`	Use this token instead of the stored one. Handy for scripts and CI.
`PERIDOT_API_URL`	API address. Default `https://tryperidot.io/api`.
`PERIDOT_WEB_URL`	Website address. Default `https://tryperidot.io`.

Build from source#

The CLI is open source: Peridot-AI/peridot-cli. You need Bun:

bash

bun install
bun run dev          # watch mode
bun start            # run once
bun run build        # a single binary in dist/peridot

← Patterns and tips Plugins →