You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(README) Show the CLI instead of describing it
why: The README's only visual was a single GIF, tucked above the donations
footer, that predates most of the current CLI. Readers had to infer what
add, discover, list, search, and status actually print.
what:
- Lead with a sync demo, so the core loop is visible before the install steps
- Illustrate add, discover, list, search, and status beside their sections
- Drop the stale demo GIF, which no longer resembled any command's output
Copy file name to clipboardExpand all lines: README.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,8 @@ See the [documentation](https://vcspull.git-pull.com/), [configuration](https://
21
21
[myrepos]: http://myrepos.branchable.com/
22
22
[mu-repo]: http://fabioz.github.io/mu-repo/
23
23
24
+
<imgsrc="https://raw.githubusercontent.com/vcs-python/vcspull/master/docs/_static/demos/asciinema/vcspull-sync.gif"alt="vcspull sync cloning a workspace of repositories"width="100%" />
yourself instead of having vcspull merge them automatically.
110
112
- Follow with `vcspull sync my-lib` to clone or update the working tree after registration.
111
113
114
+
<img src="https://raw.githubusercontent.com/vcs-python/vcspull/master/docs/_static/demos/asciinema/vcspull-add.gif" alt="vcspull add registering a repository from its checkout" width="100%" />
115
+
112
116
### Discover local checkouts and add en masse
113
117
114
118
Have a directory tree full of cloned Git repositories? Scan and append them to
@@ -123,6 +127,8 @@ The scan shows each repository before import unless you opt into `--yes`. Add
123
127
than the default `~/.vcspull.yaml`. Duplicate workspace roots are merged by
124
128
default; include `--no-merge` to keep them separate while you review the log.
125
129
130
+
<img src="https://raw.githubusercontent.com/vcs-python/vcspull/master/docs/_static/demos/asciinema/vcspull-discover.gif" alt="vcspull discover scanning a directory tree for repositories" width="100%" />
131
+
126
132
### Import from remote services
127
133
128
134
Pull repository lists from GitHub, GitLab, Codeberg, Gitea, Forgejo, or AWS
<img src="https://raw.githubusercontent.com/vcs-python/vcspull/master/docs/_static/demos/asciinema/vcspull-search.gif" alt="vcspull search narrowing a set of repositories to matches" width="100%" />
178
+
169
179
### Check repository status
170
180
171
181
Get a quick health check for all configured workspaces:
@@ -176,6 +186,8 @@ $ vcspull status --detailed
176
186
$ vcspull status --ndjson | jq --slurp 'map(select(.reason == "summary"))'
177
187
```
178
188
189
+
<img src="https://raw.githubusercontent.com/vcs-python/vcspull/master/docs/_static/demos/asciinema/vcspull-status.gif" alt="vcspull status reporting clean, dirty, and missing repositories" width="100%" />
190
+
179
191
The status command respects `--workspace/-w` filters and the global
180
192
`--color {auto,always,never}`flag. JSON and NDJSON output mirrors the list
0 commit comments