From eb06967171653f5f8c16e808531ce1be579ea598 Mon Sep 17 00:00:00 2001 From: Glenn Date: Wed, 17 Aug 2022 18:57:22 +0200 Subject: [PATCH] doc: Add overview --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa28760..6c7334a 100644 --- a/README.md +++ b/README.md @@ -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