Documentation
Install alforria, connect a provider, and work with the terminal UI, CLI, local server, or web client.
alforria is an AI coding agent for your terminal. It pairs a repository with LLMs to read, plan, write, edit, and review code, run tools, and manage sessions on your machine. One native Rust binary provides every surface.
The docs track the latest release. For exact versions and download assets, see the releases page.
Pick a surface
| Surface | Start it | Use it for |
|---|---|---|
| Terminal UI | alforria |
Interactive work with sessions, diffs, permissions, and questions |
| CLI | alforria run "..." |
Scripts, one-shot tasks, and automation |
| Web client | alforria web |
Supervising several sessions, including from another device |
| Local server | alforria serve |
HTTP and SSE clients, editors, and alforria attach |
All four surfaces use the same session engine and configuration. You can start a headless server and attach the TUI to it, or open the web client from the same server.
How the pieces fit
- The CLI parses your command and starts the session engine in the current project directory.
- The engine loads
opencode.jsonand provider credentials, then talks to the selected model through a named LLM adapter. - Tool calls run locally. Permissions decide whether a call is allowed, asks you first, or is denied.
- Sessions and messages are stored in SQLite under the global data directory. When the project is a Git repository, snapshots and revert are available.
- The optional local server exposes the same engine over HTTP, SSE, and PTY
websockets, and serves the embedded web client at
/.
Requirements
- Linux, macOS, Windows, or WSL.
- A supported model provider and credentials.
- git for snapshots, worktrees, and diffs.
- A POSIX shell for the
bashtool. - No Node.js or other language runtime.
Where to go next
- Install alforria with the installer, a prebuilt binary, or from source.
- Follow the quickstart to connect a provider and start the first session.
- Learn the terminal UI and its default keys.
- Read the CLI reference for every command.
- Configure providers, agents, permissions, and MCP.
- Run the server and use the API.
- Supervise a fleet in the web client.
- Troubleshoot a problem.
Project and source
alforria is released by LibertAI under the MIT license. The source and issue tracker are at github.com/alforria-ai/alforria.
It started as a Rust port of opencode. Its configuration and wire formats are tested against frozen upstream fixtures, while its feature set is its own.