Skip to content

Commit 6dd112d

Browse files
committed
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
1 parent ed25b15 commit 6dd112d

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ See the [documentation](https://vcspull.git-pull.com/), [configuration](https://
2121
[myrepos]: http://myrepos.branchable.com/
2222
[mu-repo]: http://fabioz.github.io/mu-repo/
2323

24+
<img src="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%" />
25+
2426
# How to
2527

2628
## Install
@@ -109,6 +111,8 @@ $ vcspull add ~/projects/libs/my-lib
109111
yourself instead of having vcspull merge them automatically.
110112
- Follow with `vcspull sync my-lib` to clone or update the working tree after registration.
111113

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+
112116
### Discover local checkouts and add en masse
113117

114118
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
123127
than the default `~/.vcspull.yaml`. Duplicate workspace roots are merged by
124128
default; include `--no-merge` to keep them separate while you review the log.
125129

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+
126132
### Import from remote services
127133

128134
Pull repository lists from GitHub, GitLab, Codeberg, Gitea, Forgejo, or AWS
@@ -158,6 +164,8 @@ $ vcspull list --json | jq '.[].name'
158164
`--json` emits a single JSON array, while `--ndjson` streams newline-delimited
159165
objects that are easy to consume from shell pipelines.
160166

167+
<img src="https://raw.githubusercontent.com/vcs-python/vcspull/master/docs/_static/demos/asciinema/vcspull-list.gif" alt="vcspull list showing configured repositories" width="100%" />
168+
161169
Search across repositories with an rg-like query syntax:
162170

163171
```console
@@ -166,6 +174,8 @@ $ vcspull search name:django url:github
166174
$ vcspull search --fixed-strings 'git+https://github.com/org/repo.git'
167175
```
168176

177+
<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+
169179
### Check repository status
170180

171181
Get a quick health check for all configured workspaces:
@@ -176,6 +186,8 @@ $ vcspull status --detailed
176186
$ vcspull status --ndjson | jq --slurp 'map(select(.reason == "summary"))'
177187
```
178188

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+
179191
The status command respects `--workspace/-w` filters and the global
180192
`--color {auto,always,never}` flag. JSON and NDJSON output mirrors the list
181193
command for automation workflows.
@@ -285,8 +297,6 @@ $ vcspull sync "$HOME/code/*"
285297

286298
[libvcs]: https://github.com/vcs-python/libvcs
287299

288-
<img src="https://raw.githubusercontent.com/vcs-python/vcspull/master/docs/_static/vcspull-demo.gif" class="align-center" style="width:45.0%" alt="image" />
289-
290300
# Donations
291301

292302
Your donations fund development of new features, testing and support.

0 commit comments

Comments
 (0)