Skip to content

Commit c5193ed

Browse files
committed
docs(cmd): add module overview
why: Help users understand the cmd module and when to use it. what: - Add overview with links to git, hg, svn modules - Add comparison table for cmd vs sync use cases
1 parent 39a38a9 commit c5193ed

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

docs/cmd/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,21 @@ versions.
1313

1414
:::
1515

16+
## Overview
17+
18+
The `libvcs.cmd` module provides Python wrappers for VCS command-line tools:
19+
20+
- {mod}`libvcs.cmd.git` - Git commands with Manager/Cmd pattern for branches, tags, remotes, etc.
21+
- {mod}`libvcs.cmd.hg` - Mercurial commands
22+
- {mod}`libvcs.cmd.svn` - Subversion commands
23+
24+
### When to use `cmd` vs `sync`
25+
26+
| Module | Use Case |
27+
|--------|----------|
28+
| `libvcs.cmd` | Fine-grained control over individual VCS commands |
29+
| `libvcs.sync` | High-level repository cloning and updating |
30+
1631
```{toctree}
1732
:caption: API
1833

0 commit comments

Comments
 (0)