Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clideck.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Install

CliDeck works on macOS and Windows. You need Node.js installed. 
npm install -g clideck
Then run it with: 
clideck
Or run directly without installing: 
npx clideck
Open http://localhost:4000 in your browser. That’s it — you’re in.

​
Access from other devices on your network

By default, CliDeck binds to 127.0.0.1 (localhost only). To access it from another device on your LAN or over a VPN like Wireguard: 
clideck --host 0.0.0.0
You can also bind to a specific interface: 
clideck --host 192.168.1.50
Binding to 0.0.0.0 exposes CliDeck to your entire network. Only use this on trusted networks.

​
Your First Session

1

Click the + button

In the sidebar, click the + button to open the session launcher.
2

Pick an agent

You’ll see buttons for each installed agent (Claude Code, Codex, Gemini CLI, OpenCode) plus a Shell option. You can also select a project and a role before launching. Click an agent button to start.
3

Start working

A new terminal session opens. Use the agent exactly as you normally would — type prompts, run commands, everything works the same.
The sidebar now shows your session with a live status indicator and message preview. Launch a few more sessions — you’ll see all of them updating at once.
New installs ship with three example roles (Programmer, Reviewer, Product Manager) and three example prompts. These are just starting points — edit or delete them as you see fit.

​
Set Up Telemetry

Telemetry is how CliDeck knows when agents are working, idle, or finished. Without it, you get a terminal multiplexer but no status detection.
The first time you launch a Claude Code session, CliDeck shows a setup toast. Click Patch Claude and CliDeck adds lifecycle hooks to ~/.claude/settings.json. Claude will ask for one-time approval on next launch. After that, status detection works automatically.

​
What You’ll See

Once telemetry is connected, the sidebar shows:
  • Green bouncing dot — The agent is actively working (generating code, running tools)
  • “zzZ” indicator — The agent is idle, waiting for your input
  • Preview text — The last meaningful line the agent output, right in the sidebar
  • Unread dot — New output you haven’t looked at yet

​
Next Steps

Mobile Remote

Check on your agents from your phone with a QR scan.

Agent guides

Detailed setup for each supported agent.

Sessions

Resume, restart, rename, and organize your sessions.

Notifications

Get notified when agents finish working.

Roles

Define agent identities and assign them to sessions.

Autopilot

Automatic multi-agent workflow routing.