Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quickstart

Install Castellan, bring up the multiplexer and dashboard, then land a first episode — under ten minutes when install works.

What you get

Binary on PATH → mux socket → dashboard → first episode JSON.

See it first

Offline / no CDN — static transcript
$ castellan plugin list
$ castellan run --goal "reach target" --plugin gridworld
episode satisfied

Download castellan-demo.cast

1. Install

curl -fsSL https://raw.githubusercontent.com/Alphabetsoup16/Castellan/main/install.sh | bash
castellan --version

From source: Install.

2. Mux + dashboard

castellan multiplexer ensure
castellan dashboard

Defaults:

  • Socket: ~/.config/castellan/castellan.sock
  • Episodes: .castellan/episodes/
  • Config: castellan.toml when present

In another terminal:

castellan herd status

Quit the dashboard with q. Keybindings: Dashboard.

3. First episode through the mux

castellan run --goal "reach target" --plugin gridworld --mux

Episode JSON lands in .castellan/episodes/<goal-id>.json.

When an LLM/editor is wired, swap in a real goal — for example castellan run --goal "…" --plugin shell --mcp. See MCP overview and Agent guide.

Optional: offline smoke (no mux)

castellan run --goal "reach target" --plugin gridworld

Common commands

castellan --help
castellan multiplexer ensure && castellan dashboard
castellan run --goal "reach target" --plugin gridworld --mux
castellan run --goal "reach target" --plugin gridworld --rlm
castellan evolve --episodes 16 --workspace .castellan/episodes
castellan herd status
castellan drift-check
castellan mcp

Next steps

GoalPage
Day-to-day operator loopDaily driver
Dashboard keybindingsDashboard
MCP tool catalogMCP tools
Wire Cursor / editorsCursor setup
Remote / SSH sessionsCLI — remote
Contributor verify before PRVerify
VocabularyConventions