compozy worktree remove
Remove a worktree
566 pages in CLI Reference
On this page4
Usage
compozy worktree remove <ref> | --path <path> [flags]Options5
- --delete-branch
- Also delete the local branch; root HEAD and default branches are kept, unmerged ones need --force
- --force
- Confirm destructive removal; with --delete-branch, also delete an unmerged branch
- --help-h
- help for remove
- --pathstring
- Remove a discovered (not adopted) worktree by its listed path; its branch is kept
- --workspacestring
- Override workspace context (ID, name, or path)
Inherited options3
- --json
- Emit JSON output
- --output-ostring
- Output format: human, json, jsonl, or toon (default "human")
- --profilestring
- Act as a profile for this command
Output Formats
The root -o, --output flag accepts these values. A renderer is supported only when this command writes that result; jsonl is for commands that emit one JSON record per line.
| Format | Command result |
|---|---|
human | Interactive terminal rendering |
json | Machine-readable JSON rendering |
jsonl | One JSON record per line when supported |
toon | Compact agent-readable rendering |
Example:
compozy worktree remove <ref> | --path <path> -o json