Installation
Claude Deck must run in the same environment where your agent CLIs and credentials are installed. Docker is not supported because containers cannot see host-installed CLIs, host tmux sessions, native agent credentials, or your real repository environment.
Claude Deck 3.0.0 includes the Overview, Work, Repositories and Harnesses pages. Older packaged releases can show the earlier configuration home page. The installation prerequisites still apply.
Native Installation
Prerequisites
- Python 3.11+
- Node.js 18+
- At least one supported local agent CLI installed on the same host:
- Claude Code
- Codex CLI
- GitHub Copilot CLI
- OpenCode CLI
- Pi
Pi has additional requirements:
- Pi 0.87.1
- Node.js 22.19.0 or later
- The dependencies of the repository-local Agent Mail extension in
integrations/pi-agent-mail, prepared before you launch Pi from Deck
Agent Mail has no Pi install action. Its Pi Agent Mail card on the Install tab only checks whether the extension is ready.
Steps
- Clone the repository:
git clone https://github.com/adrirubio/claude-deck.git
cd claude-deck- Run the install script:
./scripts/install.shThis script:
- Creates a Python virtual environment in
backend/venv/ - Installs Python dependencies from
backend/requirements.txt - Installs Node.js dependencies in
frontend/ - Installs documentation dependencies in
docs/ - Creates required directories
- Start Claude Deck:
./scripts/dev.shClaude Deck starts the backend at http://localhost:8000 and the frontend dev server at http://localhost:5173.
- Verify the installation:
# Check backend
(cd backend && source venv/bin/activate && python -c "import fastapi; print('Backend OK')")
# Check frontend and docs
./scripts/build.shUpgrade and Rollback
Claude Deck runs from a clone of the repository. An upgrade changes the source. It keeps your database, your operator and GitHub settings in backend/.env, and your agent configuration files.
Upgrade
- Stop Claude Deck.
- Copy the database while Deck is stopped. The database uses SQLite WAL mode, so committed data can be in the
-walfile. Use the SQLite backup command and keep the copy outside the repository:
sqlite3 backend/claude_registry.db ".backup '$HOME/claude_registry.db.before-3.0.0'"Without sqlite3, copy claude_registry.db, claude_registry.db-wal and claude_registry.db-shm together. If DATABASE_URL in backend/.env sets another database path, back up that database.
- Copy
backend/.envif you have one. Also create a Backup in the Backup page if you plan to edit agent configuration. - Update the source and install the dependencies:
git fetch --tags
git checkout v3.0.0
./scripts/install.sh- Start Claude Deck with
./scripts/dev.sh.
Do not delete the database. At startup, Deck adds the listed missing columns and indexes in place and records one-time data migrations. The first start after an upgrade also installs one audit coverage marker. See Factory audit and metrics.
Rollback
The startup steps do not support downgrade. To roll back, restore the copy you made before the upgrade:
- Stop Claude Deck.
- Check out the earlier version. For example,
git checkout v2.0.1, then run./scripts/install.sh. - Remove
backend/claude_registry.db-walandbackend/claude_registry.db-shm. A stale file from 3.0.0 can damage the restored database. Then replacebackend/claude_registry.dbwith your copy, for example~/claude_registry.db.before-3.0.0. - Keep
backend/.envunchanged. Start Claude Deck.
Records written after the upgrade are not in the copy. They are lost when you restore it. Rollback does not change your agent configuration files. Use the Backup page to restore those files.
Configuration
The dashboard and native pages start with the code defaults in backend/app/config.py. Settings can also come from environment variables or backend/.env. Factory polling (github_token) and operator-protected actions (operator_token) need host settings; see Autonomous GitHub dispatch. The SQLite database is created automatically on first run at backend/claude_registry.db.
Remote Use
For remote access, install and run Claude Deck natively on the remote host where the agents, credentials, repositories, and tmux sessions exist. Then connect from your browser over a trusted tunnel or network route.
What Gets Read
Claude Deck reads these Claude Code configuration files:
| File/Directory | Scope | Description |
|---|---|---|
~/.claude.json | User | OAuth, caches, MCP servers |
~/.claude/settings.json | User | User settings, permissions |
~/.claude/settings.local.json | User | Local overrides |
~/.claude/commands/ | User | User slash commands |
~/.claude/agents/ | User | User agents |
~/.claude/skills/ | User | User skills |
~/.claude/projects/ | User | Session transcripts & usage |
.claude/settings.json | Project | Project settings |
.claude/commands/ | Project | Project commands |
.mcp.json | Project | Project MCP servers |
CLAUDE.md | Project | Project instructions |
