Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,12 @@ shells out to a few host tools. You need:
`tmux -L panopticon` server
- **git:** the session service clones a per-task workspace for each agent
- The **`claude` CLI:** first-time setup runs `claude setup-token` on the host to mint the
Claude auth token each agent uses inside its container
Claude auth token each agent uses inside its container. Minting a token needs a **paid Claude
subscription or Console login**; an `ANTHROPIC_API_KEY` works instead. See
[`docs/auth.md`](docs/auth.md).

`panopticon quickstart` checks these first; run `panopticon doctor` to re-check any time.
`panopticon quickstart` checks these first; run `panopticon doctor` to re-check any time. On macOS
you need Docker **Desktop** specifically; see [`docs/macos-setup.md`](docs/macos-setup.md).

## Install

Expand Down Expand Up @@ -101,10 +104,14 @@ fleet from the dashboard.

On the dashboard:

1. **Create it.** Press `n`, then pick the repo and a workflow: `github-peer-reviewed` (opens a PR
to merge) or `local-git-self-reviewed` (stays on local git, no GitHub needed). Describe
the work in a sentence or two. See [`docs/workflows/`](docs/workflows/README.md) for the full
catalog and how to choose.
1. **Create it.** Press `n`, then pick the repo and a workflow. `quickstart` already enabled the
coding workflow that matches your repo: `github-peer-reviewed` for a GitHub repo (opens a PR), or
`local-git-self-reviewed` for a local-only one (keeps commits local). `spike` (open-ended, no
gates) is always available too. To use a different workflow, enable it for your repo in the
repos form (press `g`, edit the repo, and check the workflows you want). GitHub workflows need a
`GH_TOKEN` in the repo's env-file so the container's `gh` can open PRs (see
[`docs/auth.md`](docs/auth.md)). Describe the work in a sentence or two; the
[workflow catalog](docs/workflows/README.md) explains how to choose.
2. **Watch it start.** The task's `container` column moves `queued → … → live` as the runner
spawns its container; once it's `live` the agent starts on its own branch and begins planning
automatically. Press `a` to open its plan when it's ready.
Expand All @@ -129,3 +136,21 @@ variable (resolution is `$PANOPTICON_*` → `$XDG_*_HOME/panopticon` → the def
| Artifacts + per-task clones | `~/.local/share/panopticon/` | `PANOPTICON_DATA` |
| Layers, secrets, workflows | `~/.config/panopticon/` | `PANOPTICON_CONFIG` (workflows also via the `--workflows-path` flag) |
| Per-repo clone cache | `~/.cache/panopticon/repos/` | `PANOPTICON_CACHE` |

## Managing your install

- **Bring it back up** after a reboot or after you quit: `panopticon start` starts the services and
opens the dashboard. `panopticon console` re-attaches when the services are already running.
- **Stop everything:** `panopticon stop` removes the task containers and the `-L panopticon` tmux
server. Your data under `~/.local/share/panopticon` is left in place.
- **Check your host:** `panopticon doctor` verifies Python, Docker (and a running daemon), tmux,
git, and the `claude` CLI, printing a line per check and exiting non-zero if anything is missing.
- **Upgrade:** `pipx upgrade panopticon-app` (or `pip install --upgrade panopticon-app`), then
`panopticon migrate` to apply any new database migrations.
- **Uninstall:** `panopticon stop`, then `pipx uninstall panopticon-app`. To remove state too,
delete `~/.local/share/panopticon`, `~/.config/panopticon`, and `~/.cache/panopticon`, and remove
the `panopticon-*` Docker images.

## License

MIT. See [`LICENSE`](LICENSE).
2 changes: 2 additions & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,9 @@ This page is the map; these guides are the detail:
- **[Tasks](tasks.md)** — the task object in full: its properties, states, and lifecycle.
- **[Containers](container.md)** — the container lifecycle, every dashboard status, and recovery.
- **[Repos](repos.md)** — configuring a repo: secrets, image layers, and capabilities.
- **[Container auth](auth.md)** — giving each repo's agents their Claude token (and a GitHub token for PRs).
- **[Image layers](layers.md)** — the composed `base → workflow → repo` image, and adding your own.
- **[Hooks](hooks.md)** — the per-repo host hook that runs before a container spawns.
- **[macOS setup](macos-setup.md)** — the Docker Desktop specifics for running on a Mac.
- **[Developing](dev.md)** — working *on* panopticon: setup, the check loop, and CI.
- **[README](../README.md)** — install, quickstart, your first task, and configuration.
6 changes: 3 additions & 3 deletions docs/workflows/setup-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ token lands in the repo's env-file.
## How you launch it

This workflow is **hidden** from the normal task-creation picker. You start it from the
**repos screen's setup hotkey**, which creates a `setup-repo` task for the highlighted
repo. (It's available for every repo; there's nothing to enable.)
**repos screen**: press `g` to open it, highlight the repo, and press `s`. That creates a
`setup-repo` task for that repo. (It's available for every repo; there's nothing to enable.)

## Lifecycle

Expand All @@ -39,6 +39,6 @@ task has no agent to gate.

## Related

- [Container authentication](../container-auth.md): what the token is for and how to set
- [Container authentication](../auth.md): what the token is for and how to set
it by hand instead.
- [Workflow catalog](README.md).
Loading