vcspull list - vcspull.cli.list

List repositories functionality for vcspull.

vcspull.cli.list.create_list_subparser(parser)

function

Create vcspull list argument subparser.

Parameters:

parser (argparse.ArgumentParser) – The parser to configure

Return type:

None

vcspull.cli.list.list_repos(repo_patterns, config_path, workspace_root, tree, output_json, output_ndjson, color, include_worktrees=False)

function

List configured repositories.

Parameters:

• repo_patterns (list[str]) – Patterns to filter repositories (fnmatch)

• config_path (pathlib.Path | None) – Path to config file, or None to auto-discover

• workspace_root (str | None) – Filter by workspace root

• tree (bool) – Group by workspace root in tree view

• output_json (bool) – Output as JSON

• output_ndjson (bool) – Output as NDJSON

• color (str) – Color mode (auto, always, never)

• include_worktrees (bool) – Include configured worktrees in the listing (default: False)

Return type:

None

vcspull.cli.list._output_flat(repos, formatter, colors, include_worktrees=False)

function

Output repositories in flat list format.

Parameters:

• repos (list[ConfigDict]) – Repositories to display

• formatter (OutputFormatter) – Output formatter

• colors (Colors) – Color manager

• include_worktrees (bool) – Whether to include configured worktrees

Return type:

None

vcspull.cli.list._output_tree(repos, formatter, colors, include_worktrees=False)

function

Output repositories grouped by workspace root (tree view).

Parameters:

• repos (list[ConfigDict]) – Repositories to display

• formatter (OutputFormatter) – Output formatter

• colors (Colors) – Color manager

• include_worktrees (bool) – Whether to include configured worktrees

Return type:

None