Documentation

Sonny is an agentic coding engine for your terminal. It runs autonomous agent sessions against the LLM provider you choose, keeps an auditable record of every turn, and lets you scale a single chat into a distributed mesh of sessions running on machines you control.

If you are new to Sonny, start with Getting Started — it takes you from a fresh install to a working chat session in about a minute.

Start here

If you want to…Read this
Install the binary and run your first sessionGetting Started
Learn every command, flag, and exit codeCLI Reference
Write the recipes Sonny runs onRecipes
Understand durable knowledge and the control planeLanning
Run sessions on remote machinesDistributed Mesh
Give Sonny tools from other processesMCP Servers
Use Sonny from a GUI or editorClient Apps

How the pieces fit together

Everything Sonny does starts from a recipe: a YAML file that names a model profile and the system prompt plus tool allowlist for a session. Recipes are covered in Recipes .

A session is one run of a recipe. Sessions are persisted to a SQLite database under your data directory, which is what makes --continue, --session, and the mesh transfer commands possible.

The mesh turns one session into many, scheduled across nodes: sonny mesh serve starts a node, sonny mesh push sends a session to it, and sonny mesh attach reconnects your terminal to a session that kept running without you.

MCP servers are how Sonny reaches tools that live in another process — a ticketing system, a database bridge, a packet-capture appliance. Every server must clear an operator-owned allowlist before it runs. See the trust model .

The source of truth

The CLI behaviour described in these pages matches the --help output of the version you have installed. Where a page states a fact about a flag, a command, or a default, the page names the source file it came from; the full mapping lives in the source repository under docs/user/cli-reference.md.

Version you are reading about
These pages describe Sonny 0.12.1. Run sonny version to check what is installed on your machine.

Subsections

CLI reference

Command-by-command reference for the sonny CLI: every command, flag, shorthand and default, taken from the tool's own --help output.

8 pages

MCP Servers

Give Sonny tools hosted by other processes over the Model Context Protocol, under an operator-controlled allowlist.

3 pages

Recipes

Build, version, and run Sonny recipes: prompts, model choices, orchestration, and tool policies.

5 pages

Lanning

The Lanning Centralized Knowledge Repository: durable knowledge and a tenant-scoped API and MCP control plane.

Client Apps

Sonny's graphical and editor clients — desktop, VS Code, remote controller, and Neovim — and how they share one local service.

3 pages

Distributed Mesh

Run Sonny as a distributed session mesh: host sessions on remote nodes, attach to them over gRPC, and move live sessions between machines.

3 pages

Pages in This Section

Getting Started

The 60-second tour of Sonny: install the binary, seed your config, write a first recipe, run one headless turn, then open the TUI.

7 min read

Install

Get a working sonny binary on your machine — pre-built release tarball, apt/rpm/apk package, or a source build — and confirm it works.

6 min read

The TUI

What the Sonny terminal UI shows you: the startup banner, the chat transcript, the sidebar, dangerous-mode disclosures, and the tool-efficiency block.

7 min read

TUI shortcuts

Every keyboard shortcut in the Sonny TUI: remappable actions, transcript navigation and find, the composer's readline keys, the prompt queue, and dialog keys — with the tui.yaml action name for each.

9 min read

Authorized development

How to build, test, lint, and submit changes to Sonny — the make targets CI mirrors, the commit-message policy, the test rules, and where to report security issues.

7 min read

Configuration

Where Sonny reads its files, how the precedence chain resolves every key, and how to find the config, data, cache, and state directories on any OS.

6 min read

Glossary

Definitions for the terms Sonny uses in its CLI, configuration files, and error messages — recipes, profiles, the mesh, nodes, authority mode, sessions, and more.

7 min read

Troubleshooting

Symptom, cause, and fix for the errors you are most likely to hit with Sonny — install, recipes, providers, the TUI and clipboard, sessions, telemetry, and the mesh.

10 min read

Licensing and access

Sonny is proprietary commercial software by CodePros.

1 min read