Skip to content

Commit 60ba590

Browse files
committed
docs(CHANGES): Note sync behavior with no args
1 parent 919cfc2 commit 60ba590

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CHANGES

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,29 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
2424
- Refreshed logo
2525
- `vcspull sync`:
2626

27+
- Empty command will now show help output
28+
29+
```console
30+
$ vcspull sync
31+
Usage: vcspull sync [OPTIONS] [REPO_TERMS]...
32+
33+
Options:
34+
-c, --config PATH Specify config
35+
-x, --exit-on-error Exit immediately when encountering an error syncing
36+
multiple repos
37+
-h, --help Show this message and exit.
38+
```
39+
40+
To achieve the equivalent behavior of syncing all repos, pass `'*'`:
41+
42+
```console
43+
$ vcspull sync '*'
44+
```
45+
46+
Depending on how shell escaping works in your shell setup with [wild card / asterisk], you may not need to quote `*`.
47+
48+
[wild card / asterisk]: https://tldp.org/LDP/abs/html/special-chars.html#:~:text=wild%20card%20%5Basterisk%5D.
49+
2750
- Terms with no match in config will show a notice (#394)
2851

2952
> No repo found in config(s) for "non_existent_repo"

0 commit comments

Comments
 (0)