Skip to content

Commit b238d83

Browse files
committed
docs(sync): Note filtering behavior
1 parent 60ba590 commit b238d83

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/cli/sync.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,41 @@
44

55
# vcspull sync
66

7+
## Filtering repos
8+
9+
As of 1.13.x, `$ vcspull sync` with no args passed will show a help dialog:
10+
11+
```console
12+
$ vcspull sync
13+
Usage: vcspull sync [OPTIONS] [REPO_TERMS]...
14+
```
15+
16+
### Sync all repos
17+
18+
Depending on how your terminal works with shell escapes for expands such as the [wild card / asterisk], you may not need to quote `*`.
19+
20+
```console
21+
$ vcspull sync '*'
22+
```
23+
24+
[wild card / asterisk]: https://tldp.org/LDP/abs/html/special-chars.html#:~:text=wild%20card%20%5Basterisk%5D.
25+
26+
### Filtering
27+
28+
Filter all repos start with "django-":
29+
30+
```console
31+
$ vcspull sync 'django-*'
32+
```
33+
34+
### Multiple terms
35+
36+
Filter all repos start with "django-":
37+
38+
```console
39+
$ vcspull sync 'django-anymail' 'django-guardian'
40+
```
41+
742
## Error handling
843

944
### Repos not found in config

0 commit comments

Comments
 (0)