Jannik/PaperClipAI
1
0 Fork 0
mirror of https://github.com/paperclipai/paperclip.git synced 2026-10-21 00:05:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add missing worktree CLI commands to DEVELOPING.md

Browse Source 
Document worktree:list, worktree:merge-history, and worktree:cleanup
commands that exist in the CLI but were missing from the worktree CLI
reference section.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
dottaandPaperclip committed 2026-03-30 01:08:53 -05:00
1 parent a14d38db8c
commit 01d254c784
1 file changed
+28
Download Patch File Download Diff File Expand all files Collapse all files
doc/DEVELOPING.md
+28
View File
@@ -256,6 +256,34 @@ pnpm paperclipai worktree env --json
eval "$(pnpm paperclipai worktree env)"
```
**`pnpm paperclipai worktree:list [options]`** — List git worktrees visible from this repo and whether they look like Paperclip worktrees.
| Option | Description |
|---|---|
| `--json` | Print JSON instead of text output |
**`pnpm paperclipai worktree:merge-history [source] [options]`** — Preview or import issue/comment history from another worktree into the current instance.
| Option | Description |
|---|---|
| `[source]` | Optional source worktree path, directory name, or branch name (back-compat alias for `--from`) |
| `--from <worktree>` | Source worktree path, directory name, branch name, or `current` |
| `--to <worktree>` | Target worktree path, directory name, branch name, or `current` (defaults to current) |
| `--company <id-or-prefix>` | Shared company id or issue prefix inside the chosen source/target instances |
| `--scope <items>` | Comma-separated scopes to import: `issues`, `comments` (default: `issues,comments`) |
| `--apply` | Apply the import after previewing the plan |
| `--dry` | Preview only and do not import anything |
| `--yes` | Skip the interactive confirmation prompt when applying |
**`pnpm paperclipai worktree:cleanup <name> [options]`** — Safely remove a worktree, its branch, and its isolated instance data.
| Option | Description |
|---|---|
| `<name>` | Worktree name — auto-prefixed with `paperclip-` if needed |
| `--instance <id>` | Explicit instance id (if different from the worktree name) |
| `--home <path>` | Home root for worktree instances (default: `~/.paperclip-worktrees`) |
| `--force` | Bypass safety checks (uncommitted changes, unique commits) |
For project execution worktrees, Paperclip can also run a project-defined provision command after it creates or reuses an isolated git worktree. Configure this on the project's execution workspace policy (`workspaceStrategy.provisionCommand`). The command runs inside the derived worktree and receives `PAPERCLIP_WORKSPACE_*`, `PAPERCLIP_PROJECT_ID`, `PAPERCLIP_AGENT_ID`, and `PAPERCLIP_ISSUE_*` environment variables so each repo can bootstrap itself however it wants.
## Quick Health Checks