Skip to content

Commit 779b067

Browse files
committed
docs(readme): document new cli introspection commands
1 parent 072554e commit 779b067

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,33 @@ The scan shows each repository before import unless you opt into `--yes`. Add
119119
`-w ~/code/` to pin the resulting workspace root or `-f` to
120120
write somewhere other than the default `~/.vcspull.yaml`.
121121

122+
### Inspect configured repositories
123+
124+
List what vcspull already knows about without mutating anything:
125+
126+
```console
127+
$ vcspull list
128+
$ vcspull list --tree
129+
$ vcspull list --json | jq '.[].name'
130+
```
131+
132+
`--json` emits a single JSON array, while `--ndjson` streams newline-delimited
133+
objects that are easy to consume from shell pipelines.
134+
135+
### Check repository status
136+
137+
Get a quick health check for all configured workspaces:
138+
139+
```console
140+
$ vcspull status
141+
$ vcspull status --detailed
142+
$ vcspull status --ndjson | jq --slurp 'map(select(.reason == "summary"))'
143+
```
144+
145+
The status command respects `--workspace/-w` filters and the global
146+
`--color {auto,always,never}` flag. JSON and NDJSON output mirrors the list
147+
command for automation workflows.
148+
122149
### Normalize configuration files
123150

124151
After importing or editing by hand, run the formatter to tidy up keys and keep
@@ -137,6 +164,13 @@ discover under the standard config locations.
137164
$ vcspull sync
138165
```
139166

167+
Preview planned work with dry-run mode or generate structured output for CI:
168+
169+
```console
170+
$ vcspull sync --dry-run "*"
171+
$ vcspull sync --ndjson "*" | jq --slurp 'map(select(.reason == "summary"))'
172+
```
173+
140174
Keep nested VCS repositories updated too, lets say you have a mercurial
141175
or svn project with a git dependency:
142176

0 commit comments

Comments
 (0)