Circle documentation
Circle is a coding agent. You describe a task, and Circle reads your code, runs commands and edits files in your project, asking before it does anything that changes something. It runs in the terminal, and as a desktop application.
New here? Start with the Quickstart.
Choose what you want to do
| I want to | Read |
|---|---|
| Install Circle and run my first task | Quickstart |
| Install, update or remove Circle | Installation and updates |
| Use Circle in its own window | The desktop application |
| Understand what Circle does and why | How Circle works |
| Connect a model or switch to another | Choose a model |
| Know what it may do to my machine | Run Circle safely |
| Find out what the screen is telling me | The interface |
| Let Circle use a web page with me, such as a device’s web interface | The browser |
| Give Circle a password or a value without the model seeing it | Secrets by name |
| Steer, stop, copy, find | Use Circle in the terminal |
| Keep, reopen or branch a conversation | Sessions and context |
| Run a server, a watcher or a subagent while I keep working | Background jobs |
| Wake Circle on a clock and run a standing prompt | Scheduled tasks |
| Drive Circle from a script or an editor | CLI: print mode and JSON events, RPC mode |
| Teach Circle my project’s rules | Configuration |
| Run a command of my own before a tool or before a turn ends | Hooks |
| Add instructions on demand | Skills |
| Save a prompt as a command | Custom commands |
| Add tools from other programs | MCP servers |
| Add tools, commands or checks in JavaScript or TypeScript | Build extensions |
| Work on Circle itself | Contributing and Architecture |
| See what does not work yet | Known issues |
Get started
Guides
- Use Circle in the terminal
- The interface
- The desktop application
- Choose a model
- Sessions and context
- Background jobs
- Scheduled tasks
- Run Circle safely
- Configuration
- Skills
- Hooks
- Custom commands
- MCP servers
- Build extensions
Reference
- CLI
- RPC mode
- Slash commands
- Keyboard and mouse
- Built-in tools
- Settings
- Environment variables
- Known issues
Development
- Contributing
- Architecture
- Releasing
- The TUI contract (in the repository, in Chinese)
- Desktop application, from a checkout
- Desktop working notes (in the repository)
- Registering Circle in skills.sh
- Security policy
- Changelog