Skip to content

Commit ca50fc2

Browse files
committed
docs(cli) Show every command in action
why: Give readers a concrete view of each command beside its reference. what: - Embed the agg-rendered GIF for each top-level command - Show list tree mode in its existing reference section - Replace and remove the legacy homepage recording - Rebuild published docs when rendered GIFs change
1 parent 6dd112d commit ca50fc2

13 files changed

Lines changed: 69 additions & 1 deletion

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ jobs:
3030
- README.*
3131
docs:
3232
- 'docs/**'
33+
- 'docs/_static/demos/asciinema/*.gif'
3334
- 'examples/**'
3435
python_files:
3536
- 'src/vcspull/**'

docs/_static/vcspull-demo.gif

-1.48 MB
Binary file not shown.

docs/cli/add.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ For bulk import from remote services ([GitHub](https://github.com),
1515
[GitLab](https://gitlab.com), etc.), see {ref}`cli-import`.
1616
```
1717

18+
```{image} ../_static/demos/asciinema/vcspull-add.gif
19+
:alt: vcspull add registering a repository from its checkout
20+
:width: 100%
21+
:loading: lazy
22+
```
23+
1824
## Command
1925

2026
```{eval-rst}

docs/cli/discover.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ The `vcspull discover` command scans directories for existing
77
{ref}`configuration <configuration>`. This is ideal for importing existing
88
workspaces or migrating from other tools.
99

10+
```{image} ../_static/demos/asciinema/vcspull-discover.gif
11+
:alt: vcspull discover scanning a directory tree for repositories
12+
:width: 100%
13+
:loading: lazy
14+
```
15+
1016
## Command
1117

1218
```{eval-rst}

docs/cli/fmt.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ single section so repositories are never dropped. Prefer to review duplicates
1111
without rewriting them? Pass `--no-merge` to leave the original sections in
1212
place while still showing a warning.
1313

14+
```{image} ../_static/demos/asciinema/vcspull-fmt.gif
15+
:alt: vcspull fmt previewing a normalized configuration
16+
:width: 100%
17+
:loading: lazy
18+
```
19+
1420
## Command
1521

1622
```{eval-rst}

docs/cli/import/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ Supported services: **[GitHub](https://github.com)**,
1313
**[Gitea](https://about.gitea.com/)**, **[Forgejo](https://forgejo.org)**, and
1414
**[AWS CodeCommit](https://aws.amazon.com/codecommit/)**.
1515

16+
```{image} ../../_static/demos/asciinema/vcspull-import.gif
17+
:alt: vcspull import fetching repositories from a remote service
18+
:width: 100%
19+
:loading: lazy
20+
```
21+
1622
## Command
1723

1824
```{eval-rst}

docs/cli/list.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ The `vcspull list` command displays configured repositories from your vcspull
77
verify your configuration,
88
filter repositories by patterns, and export structured data for automation.
99

10+
```{image} ../_static/demos/asciinema/vcspull-list.gif
11+
:alt: vcspull list showing configured repositories
12+
:width: 100%
13+
:loading: lazy
14+
```
15+
1016
## Command
1117

1218
```{eval-rst}
@@ -62,6 +68,12 @@ $ vcspull list --tree
6268
• flask → ~/code/flask
6369
```
6470

71+
```{image} ../_static/demos/asciinema/vcspull-list-tree.gif
72+
:alt: vcspull list grouping repositories by workspace
73+
:width: 100%
74+
:loading: lazy
75+
```
76+
6577
## JSON output
6678

6779
Export repository information as JSON for automation and tooling:

docs/cli/migrate.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ These keys shipped at the entry root in vcspull v1.61.0. They are still read,
1212
but {ref}`cli-sync` warns when it encounters them. Migrating clears the warning
1313
and keeps configs on the supported shape.
1414

15+
```{image} ../_static/demos/asciinema/vcspull-migrate.gif
16+
:alt: vcspull migrate previewing configuration schema changes
17+
:width: 100%
18+
:loading: lazy
19+
```
20+
1521
## Command
1622

1723
```{eval-rst}

docs/cli/search.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ The `vcspull search` command looks up repositories across your vcspull
77
[rg](https://github.com/BurntSushi/ripgrep)-like query syntax. Queries are regex by default, can
88
scope to specific fields, and can emit structured JSON for automation.
99

10+
```{image} ../_static/demos/asciinema/vcspull-search.gif
11+
:alt: vcspull search narrowing a set of repositories to matches
12+
:width: 100%
13+
:loading: lazy
14+
```
15+
1016
## Command
1117

1218
```{eval-rst}

docs/cli/status.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ showing which repositories exist on disk, which are missing, and their
77
[Git](https://git-scm.com/) status. This introspection command helps verify
88
your local workspace matches your {ref}`configuration <configuration>`.
99

10+
```{image} ../_static/demos/asciinema/vcspull-status.gif
11+
:alt: vcspull status reporting clean, dirty, and missing repositories
12+
:width: 100%
13+
:loading: lazy
14+
```
15+
1016
## Command
1117

1218
```{eval-rst}

0 commit comments

Comments
 (0)