---
title: "Quickstart · Alran Code Docs"
url: https://alran.dev/en/docs/quickstart
locale: en
updated: 2026-11-16
---

[Docs](https://alran.dev/en/docs)Get started

# Quickstart

From install to a finished task in five steps.

On this page

[1. Install](#install) [2. Sign in](#sign-in) [3. Hand over a task](#task) [4. Write the project guide](#init) [5. Pick up where you left off](#continue) [Next](#next) [Common questions](#faq)

## 1. Install {#install}

```bash
curl -fsSL https://alran.dev/install.sh | bash
```

Other ways, updates and uninstalling: [Install](https://alran.dev/en/docs/install).

## 2. Sign in {#sign-in}

```bash
alran auth login     # opens the Ottili sign-in in your browser
alran auth status    # who, which company, which project
```

New accounts get welcome credit for Ottili Werk 1.1. Over SSH you confirm a code in any browser instead. More in [Sign in and accounts](https://alran.dev/en/docs/auth).

## 3. Hand over a task {#task}

Open the project and start Alran. Say what you need in one sentence.

```bash
cd ~/code/my-project
alran
```

Or give the task right away:

```bash
alran "Find the failing test, fix the code and run the tests."
```

Alran reads the project, shows a to-do list and works through it. Steps with effects outside your workspace wait for your OK. Press Shift+Tab before you send to see only the plan first.

## 4. Write the project guide {#init}

```bash
alran init .
```

Alran studies the codebase and writes `AGENTS.md`: how to build, test and what to watch out for. Every later session reads it first. Edit it like any other file.

## 5. Pick up where you left off {#continue}

```bash
alran --continue     # the latest session in this folder
alran --session      # choose from a list
```

Inside the terminal UI, `/sessions` finds earlier sessions and `/help` lists every command.

## Next {#next}

- [Goal Mode](https://alran.dev/en/docs/goal-mode): set a finish line, Alran keeps going until it is met.
- [Subagents](https://alran.dev/en/docs/subagents): split the work across a team of agents.
- [Headless and CI](https://alran.dev/en/docs/headless): run `alran exec` in scripts and pipelines.
- [Models and credit](https://alran.dev/en/docs/models): Werk on your credit, Claude Sonnet 5.5 and Opus 5.5 on your own Anthropic key.

## Common questions {#faq}

How do I get started with Alran Code?

Install Alran Code with the installer script, sign in with alran auth login and then open your project folder and tell Alran in one sentence what you need. Alran reads the project, shows a to-do list and works through it. New accounts get welcome credit for Ottili Werk 1.1.

What does alran init do and what is AGENTS.md?

Run alran init in your project and Alran studies the codebase and writes AGENTS.md. The file holds how to build and test the project and what to watch out for, and every later session reads it first. You can edit it like any other file.

Does Alran Code ask before it does something outside my project?

Yes. Alran shows a to-do list and works through it, but steps with effects outside your workspace wait for your OK. Press Shift+Tab before you send to see only the plan first.

[PreviousInstall](https://alran.dev/en/docs/install) [NextSign in and accounts](https://alran.dev/en/docs/auth)
