CLI Reference¶

Complete reference for all wcheck commands and options.

Global Options¶

wcheck [OPTIONS] COMMAND [ARGS]...

Option	Description
`--version`	Show version and exit
`--help`	Show help message and exit

status¶

Check the status of all repositories in a workspace.

wcheck status [OPTIONS]

Options¶

Option	Type	Description
`-w, --workspace-directory`	PATH	Workspace directory (default: current directory)
`-f, --full`	flag	Show all repositories, not only those with changes
`-v, --verbose`	flag	Show more detailed information
`--show-time`	flag	Show time since last commit
`--fetch`	flag	Fetch from remotes before checking status
`--gui`	flag	Launch GUI interface
`--tui`	flag	Launch TUI interface

Examples¶

Check current directory:

wcheck status

Check a specific workspace:

wcheck status -w /path/to/workspace

Show all repositories including clean ones:

wcheck status --full

Fetch and show with timestamps:

wcheck status --fetch --show-time

Launch GUI for branch management:

wcheck status --gui

Compare multiple workspaces side by side:

wcheck status -w /path/to/workspace1 -w /path/to/workspace2

This displays a table with one column per workspace, showing branch differences:

Comparing 2 workspaces
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃ Repo Name     ┃ workspace1     ┃ workspace2     ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ project-a     │ main           │ develop        │
│ project-b     │ v1.0.0 (2M)    │ v1.1.0         │
└───────────────┴────────────────┴────────────────┘

Output¶

Using workspace directory /home/user/projects
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Repo Name             ┃ Current Workspace         ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ project-a (2M 3U)     │ feature/new-feature       │
│ project-b (1↑ 2↓)     │ main                      │
│ project-c (1S)        │ develop                   │
└───────────────────────┴───────────────────────────┘

Status indicators:

U - Untracked files (orange)
M - Modified files (red)
S - Staged files (magenta)
↑ - Commits to push (green)
↓ - Commits to pull (yellow)

wconfig¶

Compare workspace repository versions with a configuration file.

wcheck wconfig [OPTIONS]

Options¶

Option	Type	Description
`-w, --workspace-directory`	PATH	Workspace directory (default: current directory)
`-c, --config`	PATH	Required. Configuration file path
`-f, --full`	flag	Show all repositories, not only mismatches
`-v, --verbose`	flag	Show more detailed information
`--show-time`	flag	Show time since last commit
`--gui`	flag	Launch GUI interface
`--tui`	flag	Launch TUI interface

Examples¶

Compare workspace to config:

wcheck wconfig -c workspace.yaml

Compare specific workspace:

wcheck wconfig -w /path/to/workspace -c config.yaml

Show all repos including matches:

wcheck wconfig -c config.yaml --full

Use GUI for branch switching:

wcheck wconfig -c config.yaml --gui

Output¶

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃ Repo Name     ┃ Workspace version ┃ Config version ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ project-a     │ feature/branch    │ main           │
│ project-b     │ v1.0.0            │ v1.1.0         │
└───────────────┴───────────────────┴────────────────┘

config-list¶

Compare multiple configuration files side by side.

wcheck config-list [OPTIONS]

Options¶

Option	Type	Description
`-c, --config`	PATH	Required. Config files (can be used multiple times)
`-f, --full`	flag	Show all repositories, not only differences
`-v, --verbose`	flag	Show more detailed information
`--show-time`	flag	Show modification time
`--full-name`	flag	Show full file paths instead of filenames

Examples¶

Compare two config files:

wcheck config-list -c robot_a.yaml -c robot_b.yaml

Compare three config files with full paths:

wcheck config-list -c /path/to/config1.yaml -c /path/to/config2.yaml -c /path/to/config3.yaml --full-name

Show all repositories:

wcheck config-list -c config_a.yaml -c config_b.yaml --full

Output¶

Comparing 2 config files
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃ Repo Name     ┃ robot_a.yaml   ┃ robot_b.yaml   ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ navigation    │ v2.0.0         │ v2.1.0         │
│ perception    │ main           │ develop        │
│ planning      │ v1.0.0         │ N/A            │
└───────────────┴────────────────┴────────────────┘

config-versions¶

Compare repository versions across git branches of a configuration file.

wcheck config-versions [OPTIONS]

Options¶

Option	Type	Description
`-c, --config`	PATH	Required. Configuration file path
`-f, --full`	flag	Show all repositories, not only differences
`-v, --verbose`	flag	Show more detailed information
`--show-time`	flag	Show modification time for each branch
`--filter`	TEXT	Filter branches by pattern (can be used multiple times)
`--stash`	flag	Stash uncommitted changes before switching branches

Examples¶

Compare across all branches:

wcheck config-versions -c workspace.yaml

Filter specific branches:

wcheck config-versions -c workspace.yaml --filter main --filter develop

Stash changes before comparing:

wcheck config-versions -c workspace.yaml --stash

Show all with verbose output:

wcheck config-versions -c workspace.yaml --full --verbose

Output¶

Comparing config versions in workspace.yaml
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Repo Name     ┃ main       ┃ develop    ┃ release    ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ project-a     │ v1.0.0     │ v1.1.0-dev │ v1.0.0     │
│ project-b     │ main       │ develop    │ v2.0.0     │
└───────────────┴────────────┴────────────┴────────────┘

GUI Mode¶

The --gui flag (with status or wconfig) opens a graphical interface.

Features:

Branch selector dropdown
Checkout button
Open in editor button
Visual status indicators
Config version comparison

Requirements

Install with: pip install wcheck[gui]

TUI Mode¶

The --tui flag (with status or wconfig) opens an interactive terminal interface.

wcheck status --tui
wcheck wconfig -c config.yaml --tui

Key bindings:

Key	Action
`↑/↓`	Navigate repositories
`Enter`	Open branch selection
`b`	Select branch (alternative)
`e`	Open in editor (`$EDITOR`)
`r`	Refresh
`q`	Quit

Features:

Repository table with status indicators
Branch selection modal
Config version comparison (in wconfig mode)
Keyboard-driven navigation

Requirements

Install with: pip install wcheck[tui]