docs: improved readme file

This commit is contained in:
Simon Cornet 2025-02-25 13:28:30 +01:00
commit da1c88be2c

View file

@ -2,20 +2,32 @@
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. :)
The program can download and update all repositories you have access to on a Gitlab server.
This works for bot gitlab.com and a selfhosted Gitlab instance. It only supports the HTTP method.
The program can clone and pull all repositories you have access to on a selfhosted or SaaS provided Gitlab server.
It only supports the HTTP access method.
# Usage
```
Usage: gogitlabber
--archived=(any|excluded|only)
--destination=$HOME/Documents
--gitlab-url=gitlab.com
--gitlab-token=<supersecrettoken>
Usage of gogitlabber:
-archived string
To include archived repositories (any|excluded|exclusive)
example: -archived=any
env = GOGITLABBER_ARCHIVED
(default "excluded")
You can also set these environment variables:
GOGITLABBER_ARCHIVED=(any|excluded|only)
GOGITLABBER_DESTINATION=$HOME/Documents
GITLAB_API_TOKEN=<supersecrettoken>
GITLAB_URL=gitlab.com
-destination string
Specify where to check the repositories out
example: -destination=$HOME/repos
env = GOGITLABBER_DESTINATION
(default "$HOME/Documents")
-gitlab-api-token string
Specify GitLab API token
example: -gitlab-api=glpat-xxxx
env = GITLAB_API_TOKEN
-gitlab-url string
Specify GitLab host
example: -gitlab-url=gitlab.com
env = GITLAB_URL
(default "gitlab.com")
```