doc: Add overview

This commit is contained in:
Glenn Y. Rolland 2022-08-17 18:57:22 +02:00
parent 9579ea57d0
commit eb06967171

View file

@ -3,12 +3,26 @@
Find, list and filter git repositories on your system.
Use cases:
* finding repositories without a remote repository defined
* finding repositories without any remote repository defined
* find repositories using a remote repository on X but not on Y (where X and Y can be Gitlab, Github, Bitbucket, Gitea, ...)
* finding repositories that are not registered in mrconfig
## Usage
## Overview
```shell-session
$ collect-repos help
Commands:
collect-repos help [COMMAND] # Describe available commands or one specific command
collect-repos list [SELECTOR] # List repositories
Options:
-r, [--root=ROOT]
```
## Example : finding repositories without any remote repository defined
```shell-session
$ collect-repos list -r . gitea=false,github=false,gitlab=false,bitbucket=false,mr=false
SELECTOR: gitea=false AND github=false AND gitlab=false AND bitbucket=false AND mr=false