CLI Commands Reference¶
This page is generated from internal/bootstrap/commands.go. Run make docs-sync after changing command definitions.
| Command | Usage | Args | Aliases | Guide |
|---|---|---|---|---|
list |
List all worktrees | - |
ls |
list |
create |
Create a new worktree | - |
- | create |
delete |
Delete a worktree | [worktree-path] |
- | delete |
rename |
Rename a worktree | <new-name> \| <worktree> <new-name> |
- | rename |
exec |
Run a command or trigger a key action in a worktree | [command] |
- | exec |
list¶
List all worktrees
| Flag | Type | Usage |
|---|---|---|
--json |
bool |
Output as JSON |
--pristine, -p |
bool |
Output paths only (one per line, suitable for scripting) |
create¶
Create a new worktree
| Flag | Type | Usage |
|---|---|---|
--exec, -x |
string |
Run a shell command after creation (in the created worktree, or current directory with --no-workspace) |
--from-branch |
string |
Create worktree from branch (defaults to current branch) |
--from-issue |
int |
Create worktree from issue number |
--from-issue-interactive, -I |
bool |
Interactively select an issue to create worktree from |
--from-pr |
int |
Create worktree from PR number |
--from-pr-interactive, -P |
bool |
Interactively select a PR to create worktree from |
--generate |
bool |
Generate name automatically from the current branch |
--no-workspace, -N |
bool |
Create local branch and switch to it without creating a worktree (requires --from-pr, --from-pr-interactive, --from-issue, or --from-issue-interactive) |
--output-selection |
string |
Write created worktree path to a file |
--query, -q |
string |
Pre-filter interactive selection (pre-fills fzf search or filters numbered list); requires --from-pr-interactive or --from-issue-interactive |
--silent |
bool |
Suppress progress messages |
--with-change |
bool |
Carry over uncommitted changes to the new worktree |
delete¶
Delete a worktree
| Flag | Type | Usage |
|---|---|---|
--no-branch |
bool |
Skip branch deletion |
--silent |
bool |
Suppress progress messages |
rename¶
Rename a worktree
| Flag | Type | Usage |
|---|---|---|
--silent |
bool |
Suppress progress messages |
exec¶
Run a command or trigger a key action in a worktree
| Flag | Type | Usage |
|---|---|---|
--key, -k |
string |
Custom command key to trigger (e.g. 't' for tmux) |
--workspace, -w |
string |
Target worktree name or path |