Skip to main content

Documentation Index

Fetch the complete documentation index at: https://panopticon-cli.com/llms.txt

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

​
Quick Start

​
One Command

npx @panctl/cli
That’s it. npx @panctl/cli starts the Panopticon browser/server experience and opens the dashboard in your browser. No global install step required. Missing tools (tmux, gh, mkcert, etc.) are prompted and installed inline the first time you use a feature that needs them.

​
Requirements

  • Node.js 22+ — the only prerequisite

​
What Happens Next

  1. Dashboard starts — Panopticon launches the local server and opens the browser UI
  2. Add a project — click the project picker and point Panopticon at a GitHub or GitLab repo
  3. Pick an issue — select an open issue from the kanban board
  4. Spawn an agent — Panopticon creates a git worktree, writes a PRD (plan), and starts coding

​
Headless / CI

For terminals, scripts, and CI where you don’t need the GUI: 
npm install -g @panctl/cli
pan up        # start dashboard server
pan work PAN-123   # spawn agent for an issue

​
Power-User Path: Install Everything Up Front

If you prefer to set up all tools at once (useful for shared dev machines or CI images): 
npm install -g @panctl/cli
pan install   # installs tmux, ttyd, mkcert, gh, glab, beads, claudish, ox
pan sync      # sync skills/agents/rules to ~/.panopticon/
pan up        # start Traefik + dashboard

​
Direct Desktop Downloads

Prefer a standalone app? Download the latest release for your platform:
  • Linux — .AppImage from GitHub Releases
  • macOS — .dmg (universal, arm64 + x64)
  • Windows — .exe (NSIS installer)

​
Architecture at a Glance

Panopticon started as a CLI for orchestrating coding agents and grew into Command Deck, a desktop app. The CLI, the GUI, and any script that can make an HTTP request all drive the same REST surface — so you can spawn an agent from a kanban card, a terminal, or a webhook without switching tools. Under the hood: an Effect.js + TypeScript server, a React frontend over typed WebSocket RPC, SQLite for state, and Electron as the shell. Launch the browser/server experience with npx @panctl/cli, use @panctl/desktop for the packaged desktop app, and keep pan for headless and CI.