Getting Started
Get agent-dashboard running in five minutes.
Prerequisites
| Dependency | Required | Purpose |
|---|---|---|
| tmux | Yes | Agent pane management and live capture |
| Claude Code | Yes | The agents this dashboard monitors |
| Node.js 18+ | Yes | Claude Code and Codex adapter hooks |
| git | Yes | Diff viewer, branch detection |
GitHub CLI (gh) | No | Detects existing PRs so g opens the diff page instead of creating a new PR |
| Codex CLI 0.130+ | No | Show Codex sessions in the dashboard |
| z (zsh plugin) | No | Frecency-ranked directory suggestions when creating sessions |
Step 1: Install the binary
Download the pre-built binary from the latest GitHub Release:
curl -fsSL https://raw.githubusercontent.com/bjornjee/agent-dashboard/main/install.sh | sh
The installer downloads the binary for your platform, verifies its SHA256 checksum, and installs it to ~/.local/bin/agent-dashboard. Hooks and skills are delivered through each host’s plugin marketplace (see Step 2 and Step 3 below); the installer does not write into ~/.codex. No Go toolchain required.
Build from source
If you prefer to build from source (requires Go 1.26+):
git clone https://github.com/bjornjee/agent-dashboard
cd agent-dashboard
./install.sh --build
Step 2: Register the plugin
In any Claude Code session, run:
/marketplace add bjornjee/agent-dashboard
/plugin install agent-dashboard@agent-dashboard
/plugin enable agent-dashboard@agent-dashboard
Then restart Claude Code sessions for hooks and skills to take effect.
Recommended companion plugins
agent-dashboard works best when paired with bjornjee/skills — a plugin of workflow skills (TDD guide, language-specific strict reviewers, refactor cleaner, codex delegation, terminal ops) that the dashboard’s session-creation flow expects:
/marketplace add bjornjee/skills
/plugin install skills@bjornjee-skills
Without it, skill-gated session types (feature, fix, chore, refactor, investigate, implement, pr, rca) will not function as intended.
Step 3: Codex CLI support
Codex support is packaged as a Codex plugin adapter in adapters/codex/. Register the marketplace entry with Codex:
codex plugin marketplace add bjornjee/agent-dashboard
Then enable the plugin by appending the following to ~/.codex/config.toml:
[plugins."agent-dashboard@agent-dashboard"]
enabled = true
Restart Codex sessions and approve the agent-dashboard hooks prompt. Once approved, the dashboard sees Codex sessions like Claude sessions — same state file, same conversation panel, same cost dashboard.
Step 4: Launch
agent-dashboard
You should see the dashboard with any running Claude Code or Codex agents listed. Try these first interactions:
j/k— navigate the agent listEnter— jump to an agent’s tmux paned— view the git diff for an agent’s workh— open the help overlay with all keybindingsq— quit
If no agents appear, start a Claude Code or Codex session in tmux first. The dashboard watches for agent state files written by the adapter hooks.
Uninstall
Remove the plugin
In any Claude Code session:
/plugin uninstall agent-dashboard@agent-dashboard
/marketplace remove agent-dashboard
Remove the binary and state
curl -fsSL https://raw.githubusercontent.com/bjornjee/agent-dashboard/main/uninstall.sh | sh
Or from a repo checkout: make uninstall. Pass --yes to skip the prompt for deleting ~/.agent-dashboard/ (which contains settings and usage data).