Documentation
Alran Code Docs
Install it, hand over your first task and make it yours. Every page is short and to the point.
Install in one line
curl -fsSL https://alran.dev/install.sh | bash macOS, Linux and WSL. Or with npm: npm install -g alran
Nothing found. Try another word.
Get started
Working with Alran
The terminal UIRun alran in a project folder. Everything happens in one screen: the conversation, the plan, the work and the status.Plan Mode and permissionsLook before it builds, and decide what it may run.Goal ModeSet a finish line. Alran keeps going, turn after turn, until it is met.Subagents and tasksOne agent? Make it a team. Alran hands parts of the work to subagents that run side by side.SessionsEvery conversation is a session, saved on your machine. Resume it, branch it, rewind it, export it.Plugins, skills and hooksSkills teach Alran a kind of work, plugins bring skills, MCP servers and hooks together. Many are built in.MCP serversConnect your own tools and services over the Model Context Protocol, per project.
Automate
Headless and CIalran exec runs one task without the TUI: in scripts, in CI, in batch jobs.Node.js and ACPDrive Alran Code from your own program, or plug it into any editor that speaks the Agent Client Protocol.VS Code extensionThe same agent in VS Code, Cursor, Windsurf and VSCodium. The extension drives the real CLI, so everything works the same.
Models
Models and creditOttili Werk 1.1 by default, Claude Sonnet 5.5 and Opus 5.5 one switch away. Werk runs on your credit, Claude on your own Anthropic key.Your own providerBring your own provider key. Those calls go straight to the provider: Ottili doesn’t see, meter or bill them.Werk APIWerk 1.1 in your own product, through the Ottili AI Platform. OpenAI-compatible: change the base URL and the model name.
Reference
CLI commandsEverything alran does from the shell.Slash commandsType / in the composer and pick a command. /help lists them in the TUI.Configuration and dataWhere Alran Code keeps its data, and the variables that change it.Error codesEvery error the terminal shows carries a number. This is what each one means and what you can do about it.TroubleshootingThe usual suspects, and how to report the rest.