doc: added readme
This commit is contained in:
parent
10d5cb4a13
commit
7cb2b51183
1 changed files with 21 additions and 0 deletions
21
readme.md
Normal file
21
readme.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# 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. :)
|
||||
|
||||
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.
|
||||
|
||||
# Usage
|
||||
```
|
||||
Usage: gogitlabber
|
||||
--archived=(any|excluded|only)
|
||||
--destination=$HOME/Documents
|
||||
--gitlab-url=gitlab.example.com
|
||||
--gitlab-token=<supersecrettoken>
|
||||
|
||||
You can also set these environment variables:
|
||||
GOGITLABBER_ARCHIVED=(any|excluded|only)
|
||||
GOGITLABBER_DESTINATION=$HOME/Documents
|
||||
GITLAB_API_TOKEN=<supersecrettoken>
|
||||
GITLAB_URL=gitlab.example.com
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue