vcspull worktree list¶

Show configured worktrees and their planned status without making changes.

Command¶

Usage¶

usage: vcspull worktree list [-h] [-f FILE] [-w DIR] [--json] [--ndjson]
                             [--color {auto,always,never}]
                             [pattern ...]

Positional Arguments¶

repo_patterns pattern¶

patterns / terms of repos, accepts globs / fnmatch(3)

Default: None

Options¶

-f, --file FILE¶

path to config file (default: ~/.vcspull.yaml or ./.vcspull.yaml)

Default: None

-w, --workspace, --workspace-root DIR¶

filter by workspace root directory

Default: None

--json¶

output as JSON

Default: False

--ndjson¶

output as NDJSON (one JSON per line)

Default: False

--color¶

when to use colors (default: auto)

Default: auto
Choices: auto, always, never

Basic usage¶

List all configured worktrees:

$ vcspull worktree list

Each worktree is displayed with a status symbol:

Symbol	Action	Meaning
`+`	CREATE	Worktree doesn’t exist yet, will be created
`~`	UPDATE	Branch worktree exists, will pull latest
`✓`	UNCHANGED	Tag/commit worktree exists, already at target
`⚠`	BLOCKED	Worktree has uncommitted changes
`✗`	ERROR	Operation failed (ref not found, etc.)

Filtering¶

Filter to specific repositories:

$ vcspull worktree list 'myproject'

Use fnmatch-style patterns:

$ vcspull worktree list 'django*'

JSON output¶

$ vcspull worktree list --json 'myproject'

NDJSON output¶

$ vcspull worktree list --ndjson 'myproject'