---
title: "Alran Code Docs: install, use and automate the AI agent"
url: https://alran.dev/en/docs
locale: en
updated: 2026-11-16
---

# Alran Code Docs

Install it, hand over your first task and make it yours. Every page is short and to the point.

## Get started

- [Install](https://alran.dev/en/docs/install): One line on macOS, Linux and WSL. Or npm, anywhere Node.js runs.
- [Quickstart](https://alran.dev/en/docs/quickstart): From install to a finished task in five steps.
- [Sign in and accounts](https://alran.dev/en/docs/auth): Alran Code signs in with your Ottili account. It never sees your password.

## Working with Alran

- [The terminal UI](https://alran.dev/en/docs/tui): Run alran in a project folder. Everything happens in one screen: the conversation, the plan, the work and the status.
- [Plan Mode and permissions](https://alran.dev/en/docs/plan-mode): Look before it builds, and decide what it may run.
- [Goal Mode](https://alran.dev/en/docs/goal-mode): Set a finish line. Alran keeps going, turn after turn, until it is met.
- [Subagents and tasks](https://alran.dev/en/docs/subagents): One agent? Make it a team. Alran hands parts of the work to subagents that run side by side.
- [Sessions](https://alran.dev/en/docs/sessions): Every conversation is a session, saved on your machine. Resume it, branch it, rewind it, export it.
- [Plugins, skills and hooks](https://alran.dev/en/docs/plugins): Skills teach Alran a kind of work, plugins bring skills, MCP servers and hooks together. Many are built in.
- [MCP servers](https://alran.dev/en/docs/mcp): Connect your own tools and services over the Model Context Protocol, per project.

## Automate

- [Headless and CI](https://alran.dev/en/docs/headless): alran exec runs one task without the TUI: in scripts, in CI, in batch jobs.
- [Node.js and ACP](https://alran.dev/en/docs/sdk): Drive Alran Code from your own program, or plug it into any editor that speaks the Agent Client Protocol.
- [VS Code extension](https://alran.dev/en/docs/vscode): The same agent in VS Code, Cursor, Windsurf and VSCodium. The extension drives the real CLI, so everything works the same.

## Models

- [Models and credit](https://alran.dev/en/docs/models): Ottili 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 provider](https://alran.dev/en/docs/byok): Bring your own provider key. Those calls go straight to the provider: Ottili doesn’t see, meter or bill them.
- [Werk API](https://alran.dev/en/docs/api): Werk 1.1 in your own product, through the Ottili AI Platform. OpenAI-compatible: change the base URL and the model name.

## Reference

- [CLI commands](https://alran.dev/en/docs/cli): Everything alran does from the shell.
- [Slash commands](https://alran.dev/en/docs/commands): Type / in the composer and pick a command. /help lists them in the TUI.
- [Configuration and data](https://alran.dev/en/docs/config): Where Alran Code keeps its data, and the variables that change it.
- [Error codes](https://alran.dev/en/docs/errors): Every error the terminal shows carries a number. This is what each one means and what you can do about it.
- [Troubleshooting](https://alran.dev/en/docs/troubleshooting): The usual suspects, and how to report the rest.
