Files
paperclip-harness/docs/outline/02-config-and-env.md

59 lines
1.9 KiB
Markdown

# Configuration and environment
## Required
| Name | Where | What it is |
|---|---|---|
| `PAPERCLIP_BOARD_KEY` | `~/.config/environment.d/10-secrets.conf` | the person's key. All writes use it. |
| `PAPERCLIP_API_KEY` | the same file | the agent key. Use it for reads only. Writes are refused outside a run. |
| `MOUSE_API_KEY` | the same file | the Mouse-1 API key |
| `GITEA_TOKEN` | the same file | used once, to create and push the repository |
Never print a key. Never commit a key. Never put a key in a prompt.
## The project file
`<folder>/.harness/harness.toml`:
```toml
session = "paperclip-harness"
watching = "AUD-171"
[paperclip]
company = "d4921013-…"
project = "17adbb47-…"
[machine]
host = "nixos-desktop"
folder = "/tmp/pc-sandbox-2026-11-10"
```
`bin/office <folder>` writes it and also writes `.harness/check.sh` and `.harness/NOTES.md` when
they are missing. It never overwrites an existing file.
## Paths that matter
| What | Where |
|---|---|
| task worktrees | `<folder>/.paperclip/worktrees/<branch>` |
| Pi conversations | `~/.pi/paperclips/<timestamp>-<agentId>.jsonl` |
| Pi skills (installed by Paperclip) | `~/.pi/agent/skills/` |
| the person's skills | `~/.agents/skills/` |
| Paperclip data | `~/.paperclip/instances/default/` |
| merge log | `/tmp/paperclip-harness-merge.log` |
| rebuild log | `/tmp/paperclip-harness-rebuild.log` |
## Instance settings that change behaviour
- `enableIsolatedWorkspaces` and `enableWorktreeRunExecution` must be true, or no task gets a
worktree. `GET /api/instance/settings/experimental` shows them.
- `enableIsolatedWorkspacesByDefault` is left off. Only projects that ask for a worktree get one.
## Machines, measured 2026-11-11
| | `.13` | `.27` | `.51` |
|---|---|---|---|
| Go | 1.26.5 | 1.26.2 | installed in config, needs a rebuild |
| Pi | 0.82.1 | 0.82.1 | 0.87.1 |
| TUIOS | 0.12.1 | 0.12.1 | 0.12.1 |