panopticon-cli 0.4.6 → 0.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -2
- package/scripts/heartbeat-hook +149 -0
- package/scripts/install-git-hooks.sh +66 -0
- package/scripts/notify-complete +79 -0
- package/scripts/postinstall.mjs +49 -0
- package/scripts/pre-tool-hook +60 -0
- package/scripts/record-cost-event.js +94 -0
- package/scripts/record-cost-event.ts +113 -0
- package/scripts/restart-dashboard.sh +59 -0
- package/scripts/setup-certs.sh +66 -0
- package/scripts/specialist-stop-hook +106 -0
- package/scripts/stop-hook +58 -0
- package/scripts/validate-merge.sh +119 -0
- package/skills/beads/README.md +120 -0
- package/skills/beads/SKILL.md +214 -0
- package/skills/beads/adr/0001-bd-prime-as-source-of-truth.md +59 -0
- package/skills/beads/resources/AGENTS.md +62 -0
- package/skills/beads/resources/ASYNC_GATES.md +168 -0
- package/skills/beads/resources/BOUNDARIES.md +469 -0
- package/skills/beads/resources/CHEMISTRY_PATTERNS.md +197 -0
- package/skills/beads/resources/CLI_REFERENCE.md +558 -0
- package/skills/beads/resources/DEPENDENCIES.md +747 -0
- package/skills/beads/resources/INTEGRATION_PATTERNS.md +407 -0
- package/skills/beads/resources/ISSUE_CREATION.md +139 -0
- package/skills/beads/resources/MOLECULES.md +354 -0
- package/skills/beads/resources/PATTERNS.md +341 -0
- package/skills/beads/resources/RESUMABILITY.md +207 -0
- package/skills/beads/resources/STATIC_DATA.md +54 -0
- package/skills/beads/resources/TROUBLESHOOTING.md +489 -0
- package/skills/beads/resources/WORKFLOWS.md +623 -0
- package/skills/beads/resources/WORKTREES.md +94 -0
- package/skills/beads-completion-check/SKILL.md +90 -0
- package/skills/beads-panopticon-guide/SKILL.md +171 -0
- package/skills/bug-fix/SKILL.md +32 -0
- package/skills/clear-writing/SKILL.md +105 -0
- package/skills/clear-writing/references/elements-of-style/01-introductory.md +3 -0
- package/skills/clear-writing/references/elements-of-style/02-elementary-rules-of-usage.md +214 -0
- package/skills/clear-writing/references/elements-of-style/03-elementary-principles-of-composition.md +398 -0
- package/skills/clear-writing/references/elements-of-style/04-a-few-matters-of-form.md +89 -0
- package/skills/clear-writing/references/elements-of-style/05-words-and-expressions-commonly-misused.md +342 -0
- package/skills/clear-writing/references/signs-of-ai-writing.md +901 -0
- package/skills/code-review/SKILL.md +37 -0
- package/skills/code-review-performance/SKILL.md +53 -0
- package/skills/code-review-security/SKILL.md +35 -0
- package/skills/dependency-update/SKILL.md +30 -0
- package/skills/feature-work/SKILL.md +39 -0
- package/skills/incident-response/SKILL.md +32 -0
- package/skills/knowledge-capture/SKILL.md +463 -0
- package/skills/onboard-codebase/SKILL.md +34 -0
- package/skills/opus-plan/SKILL.md +400 -0
- package/skills/pan-approve/SKILL.md +136 -0
- package/skills/pan-code-review/SKILL.md +249 -0
- package/skills/pan-config/SKILL.md +164 -0
- package/skills/pan-convoy-synthesis/SKILL.md +249 -0
- package/skills/pan-diagnose/SKILL.md +360 -0
- package/skills/pan-docker/SKILL.md +279 -0
- package/skills/pan-docs/SKILL.md +113 -0
- package/skills/pan-down/SKILL.md +434 -0
- package/skills/pan-health/SKILL.md +240 -0
- package/skills/pan-help/SKILL.md +237 -0
- package/skills/pan-install/SKILL.md +339 -0
- package/skills/pan-issue/SKILL.md +596 -0
- package/skills/pan-kill/SKILL.md +172 -0
- package/skills/pan-logs/SKILL.md +255 -0
- package/skills/pan-network/SKILL.md +320 -0
- package/skills/pan-oversee/SKILL.md +290 -0
- package/skills/pan-plan/SKILL.md +521 -0
- package/skills/pan-projects/SKILL.md +239 -0
- package/skills/pan-quickstart/SKILL.md +440 -0
- package/skills/pan-reload/SKILL.md +44 -0
- package/skills/pan-rescue/SKILL.md +271 -0
- package/skills/pan-restart/SKILL.md +53 -0
- package/skills/pan-setup/SKILL.md +478 -0
- package/skills/pan-skill-creator/SKILL.md +168 -0
- package/skills/pan-skill-creator/references/output-patterns.md +141 -0
- package/skills/pan-skill-creator/references/workflows.md +90 -0
- package/skills/pan-skill-creator/scripts/init_skill.py +176 -0
- package/skills/pan-status/SKILL.md +493 -0
- package/skills/pan-subagent-creator/SKILL.md +295 -0
- package/skills/pan-subagent-creator/assets/validate-readonly-query.sh +35 -0
- package/skills/pan-subagent-creator/references/example-agents.md +308 -0
- package/skills/pan-subagent-creator/scripts/init_agent.py +126 -0
- package/skills/pan-sync/SKILL.md +272 -0
- package/skills/pan-tell/SKILL.md +157 -0
- package/skills/pan-test-config/SKILL.md +208 -0
- package/skills/pan-tracker/SKILL.md +288 -0
- package/skills/pan-up/SKILL.md +458 -0
- package/skills/pan-workspace-config/SKILL.md +303 -0
- package/skills/refactor/SKILL.md +30 -0
- package/skills/refactor-radar/SKILL.md +475 -0
- package/skills/release/SKILL.md +25 -0
- package/skills/send-feedback-to-agent/SKILL.md +98 -0
- package/skills/session-health/SKILL.md +76 -0
- package/skills/session-health/scripts/check_sessions.py +166 -0
- package/skills/skill-creator/SKILL.md +92 -0
- package/skills/skill-creator/scripts/init_skill.py +152 -0
- package/skills/skill-creator/scripts/package_skill.py +123 -0
- package/skills/stitch-design-md/README.md +34 -0
- package/skills/stitch-design-md/SKILL.md +172 -0
- package/skills/stitch-design-md/examples/DESIGN.md +154 -0
- package/skills/stitch-react-components/README.md +36 -0
- package/skills/stitch-react-components/SKILL.md +47 -0
- package/skills/stitch-react-components/examples/gold-standard-card.tsx +80 -0
- package/skills/stitch-react-components/package-lock.json +231 -0
- package/skills/stitch-react-components/package.json +16 -0
- package/skills/stitch-react-components/resources/architecture-checklist.md +15 -0
- package/skills/stitch-react-components/resources/component-template.tsx +37 -0
- package/skills/stitch-react-components/resources/stitch-api-reference.md +14 -0
- package/skills/stitch-react-components/resources/style-guide.json +27 -0
- package/skills/stitch-react-components/scripts/fetch-stitch.sh +30 -0
- package/skills/stitch-react-components/scripts/validate.js +68 -0
- package/skills/stitch-setup/SKILL.md +94 -0
- package/skills/web-design-guidelines/SKILL.md +39 -0
- package/skills/work-complete/SKILL.md +79 -0
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pan-projects
|
|
3
|
+
description: Add, remove, and manage Panopticon-managed projects
|
|
4
|
+
triggers:
|
|
5
|
+
- pan projects
|
|
6
|
+
- add project
|
|
7
|
+
- remove project
|
|
8
|
+
- list projects
|
|
9
|
+
- manage projects
|
|
10
|
+
- register project
|
|
11
|
+
allowed-tools:
|
|
12
|
+
- Bash
|
|
13
|
+
- Read
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Project Management
|
|
17
|
+
|
|
18
|
+
## Overview
|
|
19
|
+
|
|
20
|
+
This skill guides you through managing projects with Panopticon. Projects must be registered before Panopticon can create workspaces and spawn agents for them.
|
|
21
|
+
|
|
22
|
+
## When to Use
|
|
23
|
+
|
|
24
|
+
- Adding a new project to Panopticon
|
|
25
|
+
- Listing managed projects
|
|
26
|
+
- Removing a project from Panopticon
|
|
27
|
+
- Setting up project-to-tracker mappings
|
|
28
|
+
|
|
29
|
+
## Core Concepts
|
|
30
|
+
|
|
31
|
+
**Project**: A local git repository that Panopticon manages
|
|
32
|
+
**Workspace**: Isolated environment created within a project for an issue
|
|
33
|
+
**Mapping**: Link between tracker project/repo and local project path
|
|
34
|
+
|
|
35
|
+
## Commands
|
|
36
|
+
|
|
37
|
+
### Add a Project
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Basic: Register a project with auto-detected name
|
|
41
|
+
pan project add /path/to/your/project
|
|
42
|
+
|
|
43
|
+
# With explicit name
|
|
44
|
+
pan project add /path/to/your/project --name myproject
|
|
45
|
+
|
|
46
|
+
# Example
|
|
47
|
+
pan project add /home/user/projects/my-app --name myapp
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### List Projects
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pan project list
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Output:
|
|
57
|
+
```
|
|
58
|
+
Registered Projects:
|
|
59
|
+
myapp /home/user/projects/my-app
|
|
60
|
+
backend /home/user/projects/backend
|
|
61
|
+
frontend /home/user/projects/frontend
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Remove a Project
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
pan project remove myproject
|
|
68
|
+
|
|
69
|
+
# Example
|
|
70
|
+
pan project remove myapp
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
**Note:** This only removes the project from Panopticon's registry. It does NOT delete the actual project files.
|
|
74
|
+
|
|
75
|
+
## Project Requirements
|
|
76
|
+
|
|
77
|
+
For a project to work well with Panopticon:
|
|
78
|
+
|
|
79
|
+
1. **Git repository**: Must be a git repo (has `.git/`)
|
|
80
|
+
2. **Clean state**: Should have a clean working tree for worktree creation
|
|
81
|
+
3. **Main branch**: Should have a main/master branch to branch from
|
|
82
|
+
|
|
83
|
+
### Optional Enhancements
|
|
84
|
+
|
|
85
|
+
| File | Purpose |
|
|
86
|
+
|------|---------|
|
|
87
|
+
| `CLAUDE.md` | Project-specific AI instructions |
|
|
88
|
+
| `.claude/skills/` | Project-specific skills |
|
|
89
|
+
| `dev` script | Start development containers |
|
|
90
|
+
| `docker-compose.yml` | Container orchestration |
|
|
91
|
+
|
|
92
|
+
## Project Configuration Files
|
|
93
|
+
|
|
94
|
+
### projects.json
|
|
95
|
+
|
|
96
|
+
Located at `~/.panopticon/projects.json`:
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
[
|
|
100
|
+
{
|
|
101
|
+
"name": "myapp",
|
|
102
|
+
"path": "/home/user/projects/my-app",
|
|
103
|
+
"addedAt": "2024-01-15T10:30:00Z"
|
|
104
|
+
}
|
|
105
|
+
]
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### project-mappings.json
|
|
109
|
+
|
|
110
|
+
Located at `~/.panopticon/project-mappings.json`:
|
|
111
|
+
|
|
112
|
+
Maps tracker projects to local paths:
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
[
|
|
116
|
+
{
|
|
117
|
+
"linearProjectId": "abc123",
|
|
118
|
+
"linearProjectName": "My App",
|
|
119
|
+
"linearPrefix": "APP",
|
|
120
|
+
"localPath": "/home/user/projects/my-app"
|
|
121
|
+
}
|
|
122
|
+
]
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
For GitHub:
|
|
126
|
+
```bash
|
|
127
|
+
# In ~/.panopticon.env
|
|
128
|
+
GITHUB_LOCAL_PATHS=owner/repo=/home/user/projects/my-app
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## Workflow: Adding a New Project
|
|
132
|
+
|
|
133
|
+
### 1. Register the Project
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
pan project add /path/to/project --name myproject
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### 2. Create CLAUDE.md (Recommended)
|
|
140
|
+
|
|
141
|
+
Create a `CLAUDE.md` file in your project root with:
|
|
142
|
+
- Project overview
|
|
143
|
+
- Key directories
|
|
144
|
+
- Development guidelines
|
|
145
|
+
- Testing instructions
|
|
146
|
+
|
|
147
|
+
### 3. Set Up Tracker Mapping
|
|
148
|
+
|
|
149
|
+
For Linear:
|
|
150
|
+
```bash
|
|
151
|
+
# Edit ~/.panopticon/project-mappings.json
|
|
152
|
+
# Add entry mapping Linear project to local path
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
For GitHub:
|
|
156
|
+
```bash
|
|
157
|
+
# Add to ~/.panopticon.env
|
|
158
|
+
GITHUB_LOCAL_PATHS=owner/myrepo=/path/to/project
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### 4. Verify Setup
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
# List projects
|
|
165
|
+
pan project list
|
|
166
|
+
|
|
167
|
+
# Check issues can be fetched
|
|
168
|
+
pan work list
|
|
169
|
+
|
|
170
|
+
# Create a test workspace
|
|
171
|
+
pan workspace create ISSUE-1
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## Workflow: Project with Docker
|
|
175
|
+
|
|
176
|
+
If your project uses Docker for development:
|
|
177
|
+
|
|
178
|
+
### 1. Create a `dev` Script
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
#!/bin/bash
|
|
182
|
+
# dev - Start development environment
|
|
183
|
+
docker compose up -d
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
Make it executable:
|
|
187
|
+
```bash
|
|
188
|
+
chmod +x dev
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### 2. Create docker-compose.yml
|
|
192
|
+
|
|
193
|
+
```yaml
|
|
194
|
+
version: '3.8'
|
|
195
|
+
services:
|
|
196
|
+
app:
|
|
197
|
+
build: .
|
|
198
|
+
volumes:
|
|
199
|
+
- .:/app
|
|
200
|
+
ports:
|
|
201
|
+
- "3000:3000"
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### 3. Panopticon Integration
|
|
205
|
+
|
|
206
|
+
When you run `pan work issue ISSUE-1`, Panopticon will:
|
|
207
|
+
1. Create a workspace (git worktree)
|
|
208
|
+
2. Detect the `dev` script
|
|
209
|
+
3. Offer to start containers for the workspace
|
|
210
|
+
|
|
211
|
+
## Troubleshooting
|
|
212
|
+
|
|
213
|
+
**Problem:** `pan project add` fails
|
|
214
|
+
**Solution:**
|
|
215
|
+
- Ensure the path exists and is a git repository
|
|
216
|
+
- Check you have write permissions to `~/.panopticon/`
|
|
217
|
+
|
|
218
|
+
**Problem:** Workspaces created in wrong location
|
|
219
|
+
**Solution:**
|
|
220
|
+
- Verify project path in `pan project list`
|
|
221
|
+
- Check project-mappings.json for correct localPath
|
|
222
|
+
|
|
223
|
+
**Problem:** Agent can't find project context
|
|
224
|
+
**Solution:**
|
|
225
|
+
- Create a CLAUDE.md in project root
|
|
226
|
+
- Ensure project is registered with correct path
|
|
227
|
+
|
|
228
|
+
## Best Practices
|
|
229
|
+
|
|
230
|
+
1. **Use descriptive names**: `pan project add ... --name frontend` instead of `proj1`
|
|
231
|
+
2. **Keep mappings updated**: When moving projects, update both projects.json and mappings
|
|
232
|
+
3. **Add CLAUDE.md**: Helps agents understand your project
|
|
233
|
+
4. **Use project-specific skills**: Put custom skills in `.claude/skills/`
|
|
234
|
+
|
|
235
|
+
## Related Skills
|
|
236
|
+
|
|
237
|
+
- `/pan:config` - General configuration
|
|
238
|
+
- `/pan:tracker` - Set up issue tracker integration
|
|
239
|
+
- `/pan:docker` - Docker template setup
|
|
@@ -0,0 +1,440 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pan-quickstart
|
|
3
|
+
description: Quick start guide combining installation, setup, and first workspace
|
|
4
|
+
triggers:
|
|
5
|
+
- quick start panopticon
|
|
6
|
+
- panopticon quickstart
|
|
7
|
+
- get started with panopticon
|
|
8
|
+
- panopticon tutorial
|
|
9
|
+
allowed-tools:
|
|
10
|
+
- Bash
|
|
11
|
+
- Read
|
|
12
|
+
- Edit
|
|
13
|
+
- AskUserQuestion
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Panopticon Quick Start
|
|
17
|
+
|
|
18
|
+
## Overview
|
|
19
|
+
|
|
20
|
+
This skill provides a streamlined onboarding experience for new Panopticon users, combining installation, configuration, and creating your first workspace in a single guided workflow.
|
|
21
|
+
|
|
22
|
+
## When to Use
|
|
23
|
+
|
|
24
|
+
- First-time Panopticon users
|
|
25
|
+
- User wants fastest path to productive use
|
|
26
|
+
- User asks "how do I get started?"
|
|
27
|
+
- User wants to go from zero to running agent quickly
|
|
28
|
+
|
|
29
|
+
## Quick Start Workflow
|
|
30
|
+
|
|
31
|
+
### Step 1: Prerequisites Check
|
|
32
|
+
|
|
33
|
+
Before starting, verify you have:
|
|
34
|
+
- **Linux, macOS, or WSL2** (Windows Subsystem for Linux)
|
|
35
|
+
- **Terminal access** with bash/zsh
|
|
36
|
+
- **Internet connection** for downloading dependencies
|
|
37
|
+
|
|
38
|
+
### Step 2: Installation (5 minutes)
|
|
39
|
+
|
|
40
|
+
#### Check Current Status
|
|
41
|
+
```bash
|
|
42
|
+
pan doctor
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
If `pan` command not found, Panopticon isn't installed yet.
|
|
46
|
+
|
|
47
|
+
#### Install Panopticon
|
|
48
|
+
```bash
|
|
49
|
+
# Clone the repository
|
|
50
|
+
git clone https://github.com/eltmon/panopticon-cli.git
|
|
51
|
+
cd panopticon-cli
|
|
52
|
+
|
|
53
|
+
# Install dependencies
|
|
54
|
+
npm install
|
|
55
|
+
|
|
56
|
+
# Build CLI
|
|
57
|
+
npm run build
|
|
58
|
+
|
|
59
|
+
# Install globally (recommended)
|
|
60
|
+
npm install -g .
|
|
61
|
+
|
|
62
|
+
# Verify installation
|
|
63
|
+
pan --help
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
#### Install Prerequisites
|
|
67
|
+
```bash
|
|
68
|
+
# Use automated installer
|
|
69
|
+
pan install
|
|
70
|
+
|
|
71
|
+
# Or verify manually
|
|
72
|
+
pan doctor
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**What `pan install` does:**
|
|
76
|
+
- Checks for Node.js v18+ (installs if missing)
|
|
77
|
+
- Checks for Docker (guides installation if missing)
|
|
78
|
+
- Checks for tmux (installs if missing)
|
|
79
|
+
- Checks for Git (installs if missing)
|
|
80
|
+
|
|
81
|
+
**Expected output:** All green checkmarks from `pan doctor`
|
|
82
|
+
|
|
83
|
+
### Step 3: Configuration (2 minutes)
|
|
84
|
+
|
|
85
|
+
#### Initialize Configuration
|
|
86
|
+
```bash
|
|
87
|
+
pan init
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
This creates `~/.panopticon.env`.
|
|
91
|
+
|
|
92
|
+
#### Configure Issue Tracker
|
|
93
|
+
|
|
94
|
+
**Using Linear** (recommended):
|
|
95
|
+
```bash
|
|
96
|
+
# Edit ~/.panopticon.env and add:
|
|
97
|
+
LINEAR_API_KEY=lin_api_xxxxxxxxxxxxxxxxxxxxx
|
|
98
|
+
LINEAR_TEAM_ID=your-team-id
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Get your Linear API key:
|
|
102
|
+
1. Visit https://linear.app/settings/api
|
|
103
|
+
2. Create personal API key
|
|
104
|
+
3. Copy key (starts with `lin_api_`)
|
|
105
|
+
|
|
106
|
+
**Using GitHub**:
|
|
107
|
+
```bash
|
|
108
|
+
# Edit ~/.panopticon.env and add:
|
|
109
|
+
GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxx
|
|
110
|
+
GITHUB_OWNER=your-username-or-org
|
|
111
|
+
GITHUB_REPO=your-repo-name
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Get your GitHub token:
|
|
115
|
+
1. Visit https://github.com/settings/tokens
|
|
116
|
+
2. Generate token with `repo` scope
|
|
117
|
+
3. Copy token (starts with `ghp_`)
|
|
118
|
+
|
|
119
|
+
**Using GitLab**:
|
|
120
|
+
```bash
|
|
121
|
+
# Edit ~/.panopticon.env and add:
|
|
122
|
+
GITLAB_TOKEN=glpat-xxxxxxxxxxxxxxxxxxxxx
|
|
123
|
+
GITLAB_PROJECT_ID=12345678
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
#### Add Your First Project
|
|
127
|
+
```bash
|
|
128
|
+
# Add the project you want to work on
|
|
129
|
+
pan project add ~/projects/myapp
|
|
130
|
+
|
|
131
|
+
# Verify
|
|
132
|
+
pan project list
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
#### Verify Configuration
|
|
136
|
+
```bash
|
|
137
|
+
# Check system health
|
|
138
|
+
pan doctor
|
|
139
|
+
|
|
140
|
+
# Test tracker connection
|
|
141
|
+
pan work list
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Step 4: Start Services (1 minute)
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
# Start dashboard and services
|
|
148
|
+
pan up
|
|
149
|
+
|
|
150
|
+
# Verify services are running
|
|
151
|
+
pan status
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**What starts:**
|
|
155
|
+
- Dashboard frontend (http://localhost:3001)
|
|
156
|
+
- API server (http://localhost:3002)
|
|
157
|
+
- Traefik (if enabled, for local domains)
|
|
158
|
+
|
|
159
|
+
**Verify:** Visit http://localhost:3001 in your browser
|
|
160
|
+
|
|
161
|
+
### Step 5: Create Your First Workspace (2 minutes)
|
|
162
|
+
|
|
163
|
+
#### List Available Issues
|
|
164
|
+
```bash
|
|
165
|
+
# See issues from your tracker
|
|
166
|
+
pan work list
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
#### Create Workspace and Spawn Agent
|
|
170
|
+
```bash
|
|
171
|
+
# Replace PAN-3 with your issue ID
|
|
172
|
+
pan work issue PAN-3
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
**What happens:**
|
|
176
|
+
1. Creates isolated workspace directory
|
|
177
|
+
2. Clones code from main project
|
|
178
|
+
3. Sets up Docker containers (if configured)
|
|
179
|
+
4. Starts tmux session
|
|
180
|
+
5. Spawns AI agent in tmux session
|
|
181
|
+
6. Agent begins working on the issue
|
|
182
|
+
|
|
183
|
+
#### Monitor Agent Progress
|
|
184
|
+
```bash
|
|
185
|
+
# Check agent status
|
|
186
|
+
pan status
|
|
187
|
+
|
|
188
|
+
# View agent output in dashboard
|
|
189
|
+
# Visit http://localhost:3001 and click on the agent
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
#### Interact with Agent
|
|
193
|
+
```bash
|
|
194
|
+
# Send message to agent
|
|
195
|
+
pan work tell PAN-3 "Check if tests pass"
|
|
196
|
+
|
|
197
|
+
# View agent's work
|
|
198
|
+
# Attach to tmux session (Ctrl+b d to detach)
|
|
199
|
+
tmux attach -t agent-PAN-3
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Step 6: Review and Approve Work (when ready)
|
|
203
|
+
|
|
204
|
+
#### Check Pending Work
|
|
205
|
+
```bash
|
|
206
|
+
# See completed work awaiting review
|
|
207
|
+
pan work pending
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
#### Review in Dashboard
|
|
211
|
+
1. Visit http://localhost:3001
|
|
212
|
+
2. Click on completed work
|
|
213
|
+
3. Review code changes
|
|
214
|
+
4. Check test results
|
|
215
|
+
|
|
216
|
+
#### Approve and Merge
|
|
217
|
+
```bash
|
|
218
|
+
# Approve work, merge MR, update tracker
|
|
219
|
+
pan work approve PAN-3
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
**What happens:**
|
|
223
|
+
1. Creates merge request (if configured)
|
|
224
|
+
2. Merges to main branch (if approved)
|
|
225
|
+
3. Updates issue status in tracker
|
|
226
|
+
4. Cleans up workspace (optional)
|
|
227
|
+
|
|
228
|
+
## Complete Quick Start Script
|
|
229
|
+
|
|
230
|
+
Here's the entire workflow in one script:
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
#!/bin/bash
|
|
234
|
+
# Panopticon Quick Start
|
|
235
|
+
|
|
236
|
+
echo "=== Panopticon Quick Start ==="
|
|
237
|
+
|
|
238
|
+
# 1. Install Panopticon (skip if already done)
|
|
239
|
+
if ! command -v pan &> /dev/null; then
|
|
240
|
+
git clone https://github.com/eltmon/panopticon-cli.git
|
|
241
|
+
cd panopticon-cli
|
|
242
|
+
npm install
|
|
243
|
+
npm run build
|
|
244
|
+
npm install -g .
|
|
245
|
+
fi
|
|
246
|
+
|
|
247
|
+
# 2. Install prerequisites
|
|
248
|
+
pan install
|
|
249
|
+
|
|
250
|
+
# 3. Initialize configuration
|
|
251
|
+
pan init
|
|
252
|
+
|
|
253
|
+
# 4. Verify health
|
|
254
|
+
pan doctor
|
|
255
|
+
|
|
256
|
+
# 5. Configure tracker (manual step - prompt user)
|
|
257
|
+
echo "Please configure your issue tracker in ~/.panopticon.env"
|
|
258
|
+
echo "Add LINEAR_API_KEY or GITHUB_TOKEN"
|
|
259
|
+
read -p "Press enter when done..."
|
|
260
|
+
|
|
261
|
+
# 6. Add project (manual step - prompt user)
|
|
262
|
+
echo "Add your project directory:"
|
|
263
|
+
read -p "Project path: " PROJECT_PATH
|
|
264
|
+
pan project add "$PROJECT_PATH"
|
|
265
|
+
|
|
266
|
+
# 7. Start services
|
|
267
|
+
pan up
|
|
268
|
+
|
|
269
|
+
# 8. List issues
|
|
270
|
+
pan work list
|
|
271
|
+
|
|
272
|
+
# 9. Create first workspace (manual step - prompt user)
|
|
273
|
+
echo "Create your first workspace:"
|
|
274
|
+
read -p "Issue ID (e.g., PAN-3): " ISSUE_ID
|
|
275
|
+
pan work issue "$ISSUE_ID"
|
|
276
|
+
|
|
277
|
+
echo "=== Quick Start Complete! ==="
|
|
278
|
+
echo "Dashboard: http://localhost:3001"
|
|
279
|
+
echo "Monitor agent: pan status"
|
|
280
|
+
echo "Send message: pan work tell $ISSUE_ID \"your message\""
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
## Time Estimate
|
|
284
|
+
|
|
285
|
+
| Step | Time |
|
|
286
|
+
|------|------|
|
|
287
|
+
| Installation | ~5 minutes |
|
|
288
|
+
| Configuration | ~2 minutes |
|
|
289
|
+
| Start services | ~1 minute |
|
|
290
|
+
| Create workspace | ~2 minutes |
|
|
291
|
+
| **Total** | **~10 minutes** |
|
|
292
|
+
|
|
293
|
+
*Plus time for agent to complete work (varies by issue complexity)*
|
|
294
|
+
|
|
295
|
+
## Common First-Time Issues
|
|
296
|
+
|
|
297
|
+
### Docker not running
|
|
298
|
+
|
|
299
|
+
**Problem:** `pan workspace create` fails with Docker error
|
|
300
|
+
|
|
301
|
+
**Solution:**
|
|
302
|
+
```bash
|
|
303
|
+
# Start Docker daemon
|
|
304
|
+
sudo systemctl start docker # Linux
|
|
305
|
+
# Or start Docker Desktop (macOS/Windows)
|
|
306
|
+
|
|
307
|
+
# Verify
|
|
308
|
+
docker ps
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Ports already in use
|
|
312
|
+
|
|
313
|
+
**Problem:** `pan up` fails because ports 3001/3002 are busy
|
|
314
|
+
|
|
315
|
+
**Solution:**
|
|
316
|
+
```bash
|
|
317
|
+
# Find what's using the port
|
|
318
|
+
lsof -i :3001
|
|
319
|
+
|
|
320
|
+
# Kill the process or use different ports
|
|
321
|
+
DASHBOARD_PORT=4001 API_PORT=4002 pan up
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
### Issue tracker not configured
|
|
325
|
+
|
|
326
|
+
**Problem:** `pan work list` returns empty or errors
|
|
327
|
+
|
|
328
|
+
**Solution:**
|
|
329
|
+
```bash
|
|
330
|
+
# Verify API key is set
|
|
331
|
+
cat ~/.panopticon.env | grep API_KEY
|
|
332
|
+
|
|
333
|
+
# Test connection manually
|
|
334
|
+
# For Linear:
|
|
335
|
+
curl -X POST https://api.linear.app/graphql \
|
|
336
|
+
-H "Authorization: $LINEAR_API_KEY" \
|
|
337
|
+
-H "Content-Type: application/json" \
|
|
338
|
+
-d '{"query":"{ viewer { name } }"}'
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Agent session not starting
|
|
342
|
+
|
|
343
|
+
**Problem:** `pan work issue` completes but no tmux session
|
|
344
|
+
|
|
345
|
+
**Solution:**
|
|
346
|
+
```bash
|
|
347
|
+
# Check tmux is installed
|
|
348
|
+
which tmux
|
|
349
|
+
|
|
350
|
+
# List tmux sessions
|
|
351
|
+
tmux list-sessions
|
|
352
|
+
|
|
353
|
+
# Check for error logs
|
|
354
|
+
cat ~/.panopticon/logs/agent-*.log
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
## What You've Accomplished
|
|
358
|
+
|
|
359
|
+
After completing this quick start, you have:
|
|
360
|
+
- ✅ Panopticon installed and configured
|
|
361
|
+
- ✅ Issue tracker connected
|
|
362
|
+
- ✅ Dashboard running at http://localhost:3001
|
|
363
|
+
- ✅ First workspace created
|
|
364
|
+
- ✅ AI agent working on an issue
|
|
365
|
+
- ✅ Understanding of basic workflow
|
|
366
|
+
|
|
367
|
+
## Next Steps
|
|
368
|
+
|
|
369
|
+
### Learn More
|
|
370
|
+
- `/pan-help` - Explore all available commands
|
|
371
|
+
- `/pan-docker` - Configure Docker templates for your stack
|
|
372
|
+
- `/pan-network` - Set up local domains (feature-123.localhost)
|
|
373
|
+
- `/pan-config` - Advanced configuration options
|
|
374
|
+
|
|
375
|
+
### Productivity Tips
|
|
376
|
+
- Use dashboard to monitor multiple agents
|
|
377
|
+
- Set up beads for task tracking
|
|
378
|
+
- Configure git hooks for automated workflows
|
|
379
|
+
- Create custom skills for your team's processes
|
|
380
|
+
|
|
381
|
+
### Advanced Features
|
|
382
|
+
- **Planning sessions**: `pan work plan <id>` before spawning agent
|
|
383
|
+
- **Multiple agents**: Run agents in parallel for different issues
|
|
384
|
+
- **Custom templates**: Create Docker templates for your stack
|
|
385
|
+
- **State mapping**: Map Linear states to git branches
|
|
386
|
+
|
|
387
|
+
## Troubleshooting
|
|
388
|
+
|
|
389
|
+
If you get stuck at any step:
|
|
390
|
+
|
|
391
|
+
```bash
|
|
392
|
+
# Check system health
|
|
393
|
+
pan doctor
|
|
394
|
+
|
|
395
|
+
# View detailed logs
|
|
396
|
+
cat ~/.panopticon/logs/panopticon.log
|
|
397
|
+
|
|
398
|
+
# Check dashboard logs
|
|
399
|
+
cd panopticon-cli/src/dashboard
|
|
400
|
+
npm run dev # Run in foreground to see errors
|
|
401
|
+
|
|
402
|
+
# Get help
|
|
403
|
+
pan --help
|
|
404
|
+
pan <command> --help
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
Use these skills for specific issues:
|
|
408
|
+
- `/pan-install` - Installation problems
|
|
409
|
+
- `/pan-setup` - Configuration problems
|
|
410
|
+
- `/session-health` - Stuck or crashed agents
|
|
411
|
+
- `/pan-help` - General command reference
|
|
412
|
+
|
|
413
|
+
## Feedback and Support
|
|
414
|
+
|
|
415
|
+
If you encounter issues:
|
|
416
|
+
1. Check the troubleshooting section above
|
|
417
|
+
2. Run `pan doctor` for diagnostic info
|
|
418
|
+
3. Visit https://github.com/eltmon/panopticon-cli/issues
|
|
419
|
+
4. Join the community (link in README)
|
|
420
|
+
|
|
421
|
+
## Related Skills
|
|
422
|
+
|
|
423
|
+
- `/pan-install` - Detailed installation guide
|
|
424
|
+
- `/pan-setup` - Configuration wizard
|
|
425
|
+
- `/pan-help` - Command reference
|
|
426
|
+
- `/pan-issue` - Workspace creation details
|
|
427
|
+
- `/pan-status` - Monitoring agents
|
|
428
|
+
|
|
429
|
+
## Success Checklist
|
|
430
|
+
|
|
431
|
+
- [ ] `pan --help` works
|
|
432
|
+
- [ ] `pan doctor` shows all green checkmarks
|
|
433
|
+
- [ ] `pan work list` shows issues from your tracker
|
|
434
|
+
- [ ] Dashboard accessible at http://localhost:3001
|
|
435
|
+
- [ ] Created first workspace with `pan work issue`
|
|
436
|
+
- [ ] Agent running in tmux session
|
|
437
|
+
- [ ] Can send messages to agent with `pan work tell`
|
|
438
|
+
- [ ] Understand how to approve work with `pan work approve`
|
|
439
|
+
|
|
440
|
+
**Congratulations!** You're now ready to use Panopticon for multi-agent development workflows.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Pan Reload
|
|
2
|
+
|
|
3
|
+
Rebuild and restart the Panopticon dashboard after code changes.
|
|
4
|
+
|
|
5
|
+
## When to Use
|
|
6
|
+
|
|
7
|
+
Use this skill after merging changes to panopticon-cli that affect:
|
|
8
|
+
- Dashboard frontend (`src/dashboard/frontend/`)
|
|
9
|
+
- Dashboard server (`src/dashboard/server/`)
|
|
10
|
+
- CLI commands (`src/cli/`)
|
|
11
|
+
- Library code (`src/lib/`)
|
|
12
|
+
|
|
13
|
+
## Steps
|
|
14
|
+
|
|
15
|
+
1. **Build the project:**
|
|
16
|
+
```bash
|
|
17
|
+
cd /home/eltmon/projects/panopticon && npm run build
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
2. **Restart the dashboard:**
|
|
21
|
+
```bash
|
|
22
|
+
/home/eltmon/projects/panopticon/scripts/restart-dashboard.sh
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
3. **Verify the dashboard is running:**
|
|
26
|
+
```bash
|
|
27
|
+
curl -s http://localhost:3011/api/health | head -1
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Expected output: `{"status":"ok"...}`
|
|
31
|
+
|
|
32
|
+
## Quick One-Liner
|
|
33
|
+
|
|
34
|
+
For agents that need a single command:
|
|
35
|
+
```bash
|
|
36
|
+
cd /home/eltmon/projects/panopticon && npm run build && ./scripts/restart-dashboard.sh
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Troubleshooting
|
|
40
|
+
|
|
41
|
+
If the dashboard fails to start:
|
|
42
|
+
1. Check for port conflicts: `fuser 3010/tcp 3011/tcp`
|
|
43
|
+
2. Kill stale processes: `fuser -k 3010/tcp 3011/tcp`
|
|
44
|
+
3. Check logs: `tail -50 /tmp/dashboard.log`
|