> ## 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.

# CLI Overview

> Introduction to Overdeck's command-line interface

export const ThemedImage = ({light, dark, alt = ""}) => {
  const [darkMode, setDarkMode] = useState(null);
  useEffect(() => {
    const root = document.documentElement;
    const syncTheme = () => setDarkMode(root.classList.contains("dark"));
    const observer = new MutationObserver(syncTheme);
    syncTheme();
    observer.observe(root, {
      attributes: true,
      attributeFilter: ["class"]
    });
    return () => observer.disconnect();
  }, []);
  if (darkMode === null) return null;
  return <img src={darkMode ? dark ?? light : light} alt={alt} loading="lazy" />;
};

# CLI Overview

The Overdeck CLI (`pan`) provides a comprehensive set of commands for managing agents, workspaces, and multi-project orchestration.

Every CLI command has a counterpart in the dashboard, where the same agents, conversations, and workflow are managed visually. The Command Deck below shows a live agent: the project and conversation sidebar on the left, the issue tree, the agent's turn-by-turn tool calls and reasoning in the center, and a Needs-you / Project / Global awareness rail on the right.

<ThemedImage light="/images/dashboard/command-deck-hero-light.png" dark="/images/dashboard/command-deck-hero-dark.png" alt="Command Deck: project and conversation sidebar, issue tree, an agent's turn-by-turn tool calls and reasoning, and the Needs-you/Project/Global awareness rail" />

<Tip>
  The CLI and dashboard operate on the same state. You can spawn an agent from the terminal with `pan start MIN-123` and watch its reasoning stream into the Command Deck, or start it from the board and drive it from the CLI — they are two views of one orchestrator.
</Tip>

## Philosophy

The Overdeck CLI is designed around a few key principles:

1. **Agent-centric** - Commands focus on spawning, monitoring, and controlling AI agents
2. **Workspace isolation** - Each issue gets its own git worktree workspace
3. **Multi-project support** - Manage multiple projects from a single installation
4. **Integration-first** - Works seamlessly with GitHub, Linear, GitLab, and Rally

## Command Structure

Overdeck commands are organized into logical groups:

| Group | Purpose | Examples |
| - | - | - |
| **Core** | System management | `pan up`, `pan down`, `pan sync`, `pan doctor` |
| **Work** | Agent management | `pan start`, `pan status`, `pan tell`, `pan kill` |
| **Workspace** | Workspace lifecycle | `pan workspace create`, `pan workspace destroy` |
| **Review** | Code review loop | `pan review request`, `pan review restart`, `pan review abort` |
| **Project** | Project registry | `pan project add`, `pan project list` |
| **Conversations** | Session history and conversation metadata | `pan conv list`, `pan conv move`, `pan conv link-pr` ([linking pull requests](/features/conversations#linking-a-pull-request-by-hand)) |
| **Admin** | Specialists, remote workspaces, Cloister | `pan admin specialists list`, `pan admin remote status`, `pan admin cloister status` |

## Installation & Setup

```bash theme={null}
# Install Overdeck globally
npm install -g @overdeck/core

# Run first-time setup
pan install

# Sync skills to AI tools
pan sync

# Check system health
pan doctor
```

## Common Patterns

### Issue-based workflows

Most commands accept an issue identifier (e.g., `MIN-123`, `42`):

```bash theme={null}
pan start MIN-123           # Spawn agent
pan tell MIN-123 "msg"      # Send message
pan status                  # List all agents
pan kill MIN-123            # Stop agent
```

### Workspace management

Workspaces are git worktrees created automatically or on-demand:

```bash theme={null}
pan workspace create MIN-123         # Create workspace
pan workspace create MIN-123 --docker # With Docker containers
pan workspace destroy MIN-123        # Clean up workspace
```

### Dashboard integration

Many operations can be performed either via CLI or dashboard:

```bash theme={null}
pan up    # Start dashboard at localhost:3011
```

The dashboard provides a visual interface for all CLI operations.

## Getting Help

```bash theme={null}
# General help
pan --help

# Command-specific help
pan start --help
pan workspace --help

# Command documentation
man pan              # If installed via package manager
```

## Common Options

### Global flags

| Flag | Description |
| - | - |
| `--help` | Show help for any command |
| `--version` | Show Overdeck version |
| `--verbose` | Enable verbose output |

### Issue identifiers

Commands accept various issue identifier formats:

* **Linear**: `MIN-123`, `min-123` (case-insensitive)
* **GitHub**: `#42`, `42` (numeric)
* **GitLab**: `!42`, `42` (numeric)

## Configuration

Overdeck stores configuration in:

* `~/.overdeck.env` - API keys and tokens
* `~/.overdeck/projects.yaml` - Registered projects
* `~/.overdeck/project-mappings.json` - Linear project mappings
* Project-level: `.overdeck.json` - Project-specific settings

## Next Steps

* [Core Commands](/cli/core-commands) - System management commands
* [Agent Commands](/cli/agent-commands) - Manage AI agents
* [Workspace Commands](/cli/workspace-commands) - Workspace management
* [Review Commands](/cli/review-commands) - Request, restart, and abort code review
* [pan vault](/cli/vault) - Session Vault: save and continue conversations on another machine
* [pan pair](/cli/pair) - Pair another device with this machine's dashboard
* [pan devices](/cli/devices) - List and revoke paired devices
* [pan token](/cli/token) - Scoped API tokens for programs


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.