vcspull list - vcspull.cli.list¶
List repositories functionality for vcspull.
-
vcspull.cli.list.create_list_subparser(parser)¶vcspull.cli.list.create_list_subparser(parser)¶
Create
vcspull listargument subparser.- Parameters:
parser (
argparse.ArgumentParser) – The parser to configure- Return type:
-
vcspull.cli.list.list_repos(repo_patterns, config_path, workspace_root, tree, output_json, output_ndjson, color, include_worktrees=False)¶vcspull.cli.list.list_repos(repo_patterns, config_path, workspace_root, tree, output_json, output_ndjson, color, include_worktrees=False)¶
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-discovertree (
bool) – Group by workspace root in tree viewoutput_json (
bool) – Output as JSONoutput_ndjson (
bool) – Output as NDJSONcolor (
str) – Color mode (auto, always, never)include_worktrees (
bool) – Include configured worktrees in the listing (default: False)
- Return type:
-
vcspull.cli.list._output_flat(repos, formatter, colors, include_worktrees=False)¶vcspull.cli.list._output_flat(repos, formatter, colors, include_worktrees=False)¶
Output repositories in flat list format.
- Parameters:
repos (
list[ConfigDict]) – Repositories to displayformatter (
OutputFormatter) – Output formattercolors (
Colors) – Color managerinclude_worktrees (
bool) – Whether to include configured worktrees
- Return type:
-
vcspull.cli.list._output_tree(repos, formatter, colors, include_worktrees=False)¶vcspull.cli.list._output_tree(repos, formatter, colors, include_worktrees=False)¶
Output repositories grouped by workspace root (tree view).
- Parameters:
repos (
list[ConfigDict]) – Repositories to displayformatter (
OutputFormatter) – Output formattercolors (
Colors) – Color managerinclude_worktrees (
bool) – Whether to include configured worktrees
- Return type: