Skip to content

Installation

The fastest way to run Claude Deck:

bash
git clone https://github.com/adrirubio/claude-deck.git
cd claude-deck
docker compose up

This builds and starts Claude Deck at http://localhost:8000, mounting your ~/.claude and ~/.claude.json configuration files.

TIP

The container mounts your home directory's Claude Code configuration. The container runs as root to access these files; adjust permissions if running as a non-root user.

Manual Installation

Prerequisites

  • Python 3.11+
  • Node.js 18+

Steps

  1. Clone the repository:
bash
git clone https://github.com/adrirubio/claude-deck.git
cd claude-deck
  1. Run the install script:
bash
./scripts/install.sh

This script:

  • Creates a Python virtual environment in backend/venv/
  • Installs Python dependencies from backend/requirements.txt
  • Installs Node.js dependencies in frontend/
  • Creates required directories
  1. Verify the installation:
bash
# Check backend
cd backend && source venv/bin/activate && python -c "import fastapi; print('Backend OK')"

# Check frontend
cd frontend && npm run build

Configuration

Claude Deck requires no configuration files — all settings have sensible defaults defined in backend/app/config.py. The SQLite database is created automatically on first run at backend/claude_registry.db.

What Gets Read

Claude Deck reads these Claude Code configuration files:

File/DirectoryScopeDescription
~/.claude.jsonUserOAuth, caches, MCP servers
~/.claude/settings.jsonUserUser settings, permissions
~/.claude/settings.local.jsonUserLocal overrides
~/.claude/commands/UserUser slash commands
~/.claude/agents/UserUser agents
~/.claude/skills/UserUser skills
~/.claude/projects/UserSession transcripts & usage
.claude/settings.jsonProjectProject settings
.claude/commands/ProjectProject commands
.mcp.jsonProjectProject MCP servers
CLAUDE.mdProjectProject instructions

Released under the MIT License.