Skip to main content

Quick Start

Get Panopticon set up and create your first autonomous agent workspace.

Installation

# Install Panopticon
npm install -g panopticon-cli

# Install prerequisites and setup (includes optional HTTPS/Traefik)
pan install

# Sync skills to all AI tools
pan sync

# Check system health
pan doctor

HTTPS Setup (Optional)

Panopticon supports local HTTPS via Traefik reverse proxy:
# Full install (includes Traefik + mkcert for HTTPS)
pan install

# Start with HTTPS (pan.localhost auto-resolves, no /etc/hosts needed)
pan up
# → Dashboard: https://pan.localhost
# → Traefik UI: https://traefik.pan.localhost:8080
Minimal install (skip Traefik, use ports):
pan install --minimal
pan up
# → Dashboard: http://localhost:3011
See Docker & HTTPS Setup for detailed DNS configuration (especially for WSL2).

Supported Platforms

PlatformSupport
LinuxFull support
macOSFull support
WindowsWSL2 required
Windows users: Panopticon requires WSL2 (Windows Subsystem for Linux 2). Native Windows is not supported. Install WSL2

Requirements

Required

  • Node.js 18+
  • Git (for worktree-based workspaces)
  • Docker (for Traefik and workspace containers)
  • tmux (for agent sessions)
  • ttyd - Web terminal for interactive planning sessions. Auto-installed by pan install.
  • GitHub CLI (gh) - For GitHub integration (issues, PRs, merges). Install
  • GitLab CLI (glab) - For GitLab integration (if using GitLab). Install

Optional

  • mkcert - For HTTPS certificates (recommended)
  • Linear API key - For issue tracking integration
  • Beads CLI (bd) - For persistent task tracking across sessions. Auto-installed by pan install. Upgrade with pan beads upgrade.
  • Google Stitch MCP - For AI-powered UI design integration

Platform Support

The Panopticon dashboard includes terminal streaming, which requires a native binary (node-pty). Prebuilt binaries are available for:
PlatformArchitectureSupport
macOSIntel (x64)āœ… Prebuilt
macOSApple Silicon (arm64)āœ… Prebuilt
Linuxx64 (glibc)āœ… Prebuilt
Linuxarm64 (glibc)āœ… Prebuilt
Linuxmusl (Alpine)āœ… Prebuilt
Windowsx64āœ… Prebuilt
If a prebuilt binary is not available for your platform, node-gyp will automatically compile from source during installation (requires Python and build tools).

Why CLI tools instead of API tokens?

Panopticon uses gh and glab CLIs instead of raw API tokens because:
  • Better auth: OAuth tokens that auto-refresh (no expiring PATs)
  • Simpler setup: gh auth login handles everything
  • Agent-friendly: Agents can use them for PRs, merges, reviews

Next Steps