Quickstart
Install an adapter and launch your first agent.
This walks through the shortest path from a fresh install to a running agent.
1. First run
On first launch, atrium runs an onboarding wizard:
- Pick a workspace directory. Any directory works; git repositories get extra features (branch-aware file tree, the source control pane).
- Detect installed tools. atrium scans your
PATHforclaude,codex, andgemini. Tools that are found can be installed as adapters in one click. - Install adapters. Each installed adapter writes a small set of files under
~/.atrium/adapters/<name>/and injects a skill file into the tool's own skills directory (e.g.~/.claude/skills/atrium/skill.md) so the tool knows how to use the atrium CLI. - Pick a theme and telemetry preference.
2. Launch an agent
Open an empty terminal pane. The launcher bar sits at the top of empty panes and shows an adapter picker.
- Click an adapter (e.g. Claude Code).
- Optionally pick a recent session from the dropdown — atrium reads the adapter's own session store and offers to resume.
- Optionally add CLI args or toggle YOLO mode (skip atrium's output capture).
- Press Enter.
3. Split and arrange
Cmd+Dsplits the focused pane right.Cmd+Shift+Dsplits it down.- Drag a pane header to another split zone to move it. Dragging onto another pane's header creates a subtab group.
Cmd+Topens a new room (tab).Cmd+Shift+Ncreates a new workspace.
4. Resume after a crash or reboot
atrium uses a write-ahead journal plus periodic workspace snapshots. When it reopens:
- Pane layouts, scrollback, and working directories restore from the last snapshot.
- Agents with a detected session ID are resumed automatically via the adapter's resume command.
- Agents whose session could not be found show a "resume failed" state with a Nudge button to retry.
5. Drive atrium from the CLI
Inside any atrium pane, ATRIUM_CLI_PATH points at the installed CLI. Outside atrium, add ~/.atrium/bin to your PATH or call the binary directly.
# List all panes
"$ATRIUM_CLI_PATH" pane list
# Read the last 100 lines of a pane
"$ATRIUM_CLI_PATH" pane read <pane-id> --lines 100
# Open a file in a new editor pane
"$ATRIUM_CLI_PATH" path/to/file.ts
# Create a new task
"$ATRIUM_CLI_PATH" task create --title "Refactor auth" --source "user:me"
See the CLI reference for every subcommand.
Next
- Core concepts — the workspace/room/pane/agent mental model.
- Panes overview — every pane type and what it can do.
- Keyboard shortcuts — the full default key map.
