From 21ca8de699929521ec0a71ad305d0c8e52c86517 Mon Sep 17 00:00:00 2001 From: Simon Cornet Date: Wed, 5 Mar 2025 12:09:49 +0100 Subject: [PATCH] docs: add debug and concurrency flags to usage --- readme.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 9de4ea2..732673c 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,5 @@ # gogitlabber + This project is inspired from the python application called gitlabber (https://github.com/ezbz/gitlabber). It is mainly to learn Golang. But also to make something that specifically solves my problem. :) @@ -6,6 +7,7 @@ The program can clone and pull all repositories you have access to on a selfhost It only supports the HTTP access method. # Usage + ``` Usage of gogitlabber: -archived string @@ -14,20 +16,32 @@ Usage of gogitlabber: env = GOGITLABBER_ARCHIVED (default "excluded") + -concurrency int + Specify repository concurrency + example: -concurrency=15 + env = GOGITLABBER_CONCURRENCY + (default 15) + + -debug + Toggle debug mode + example: -debug=true + env = GOGITLABBER_DEBUG + -destination string Specify where to check the repositories out example: -destination=$HOME/repos env = GOGITLABBER_DESTINATION - (default "$HOME/Documents") + (default "/home/simon/Documents/siempie") -gitlab-api-token string Specify GitLab API token example: -gitlab-api=glpat-xxxx env = GITLAB_API_TOKEN + (default "glpat-QsUyRLKF3wPb1Ny7MLjy") -gitlab-url string Specify GitLab host example: -gitlab-url=gitlab.com env = GITLAB_URL - (default "gitlab.com") + (default "gitlab.simoncor.net") ```