> ## Documentation Index
> Fetch the complete documentation index at: https://rakumux.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Install Rakumux, run your first agent and find your way around.

**1. Install**

```bash theme={null}
curl -fsSL https://rakumux.com/install.sh | bash
```

The installer checks the release checksum before installing. See
[Installation](https://rakumux.com/docs/installation.md) for other options.

**2. Open Rakumux in a project**

```bash theme={null}
cd ~/projects/my-app
rakumux
```

A short welcome tour shows the keys the first time; press `t` in Help to see it again.

**3. Start a session and run an agent**

Press `n` (or click **+ New session**). Rakumux creates a session with a generated name and puts
you straight into its shell. Start an agent, or any command:

```bash theme={null}
claude
```

**4. Step out and look around**

Press `Ctrl-\` to switch to **Rakumux mode**. Your keys now drive Rakumux: move between sessions
with `↑`/`↓` or `j`/`k`, and each one shows live beside the list. Each row shows the session's
name, the app it runs and where it works, with its branch.

**5. Start a second agent**

Press `n` again and start another agent, on another task. Both keep running. The list opens on
the **Status** tab, so whichever agent is waiting for you, or has a reply you haven't read, is at
the top.

**6. Go back in, then quit without stopping anything**

`Enter` works in the selected session; `Esc` returns to the one you came from. `?` opens Help and
`,` opens Settings. Press `q` to quit: every session keeps running. Run `rakumux` again, from any
terminal or SSH login, and they're all still there.

> [!TIP]
>
> On a laptop, agents stop when it sleeps. Run Rakumux on a machine that's always on and they keep
> working while you're away: see [Where to run Rakumux](https://rakumux.com/docs/remote.md).

## Next

> **[Install the agent hooks](https://rakumux.com/docs/agents/activity-hooks.md)**
>
> Exact working, waiting-for-you and finished states for Claude Code, Codex and OpenCode.

> **[Run agents in parallel](https://rakumux.com/docs/workflows/parallel-agents.md)**
>
> A workflow for several agents across worktrees.

## From the command line

```bash theme={null}
rakumux new --name dev          # create a session and attach to it
rakumux ls --all                # list sessions across folders
rakumux attach dev              # one session full screen; Ctrl-\ then d detaches
rakumux daemon status           # check the background server
rakumux --help
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.