docs: add debug and concurrency flags to usage
This commit is contained in:
parent
49f65abe4a
commit
21ca8de699
1 changed files with 16 additions and 2 deletions
18
readme.md
18
readme.md
|
|
@ -1,4 +1,5 @@
|
||||||
# gogitlabber
|
# gogitlabber
|
||||||
|
|
||||||
This project is inspired from the python application called gitlabber (https://github.com/ezbz/gitlabber).
|
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. :)
|
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.
|
It only supports the HTTP access method.
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
Usage of gogitlabber:
|
Usage of gogitlabber:
|
||||||
-archived string
|
-archived string
|
||||||
|
|
@ -14,20 +16,32 @@ Usage of gogitlabber:
|
||||||
env = GOGITLABBER_ARCHIVED
|
env = GOGITLABBER_ARCHIVED
|
||||||
(default "excluded")
|
(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
|
-destination string
|
||||||
Specify where to check the repositories out
|
Specify where to check the repositories out
|
||||||
example: -destination=$HOME/repos
|
example: -destination=$HOME/repos
|
||||||
env = GOGITLABBER_DESTINATION
|
env = GOGITLABBER_DESTINATION
|
||||||
(default "$HOME/Documents")
|
(default "/home/simon/Documents/siempie")
|
||||||
|
|
||||||
-gitlab-api-token string
|
-gitlab-api-token string
|
||||||
Specify GitLab API token
|
Specify GitLab API token
|
||||||
example: -gitlab-api=glpat-xxxx
|
example: -gitlab-api=glpat-xxxx
|
||||||
env = GITLAB_API_TOKEN
|
env = GITLAB_API_TOKEN
|
||||||
|
(default "glpat-QsUyRLKF3wPb1Ny7MLjy")
|
||||||
|
|
||||||
-gitlab-url string
|
-gitlab-url string
|
||||||
Specify GitLab host
|
Specify GitLab host
|
||||||
example: -gitlab-url=gitlab.com
|
example: -gitlab-url=gitlab.com
|
||||||
env = GITLAB_URL
|
env = GITLAB_URL
|
||||||
(default "gitlab.com")
|
(default "gitlab.simoncor.net")
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue