golang/gogitlabber
golang/gogitlabber
3
0
Fork 0
Code Issues 1 Pull requests Releases 1 Activity

feat: use yaml config instead of args or envs

Browse source
This commit is contained in:
Simon Cornet 2025-07-07 10:50:31 +02:00
commit 241fe8c53b
8 changed files with 186 additions and 211 deletions
Download patch file Download diff file Expand all files Collapse all files

97
readme.md
View file

@ -1,16 +1,16 @@
# 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. 😆
It is mainly to learn Golang. But also to make something that specifically solves my problem. 😆
It is definitely not as feature-rich as the original project... 😬
The program can clone and pull all repositories you have access to on a selfhosted or SaaS provided Gitlab or Gitea server.
The program can clone and pull all repositories you have access to on a selfhosted or SaaS provided Gitlab or Gitea
server.
It only supports the HTTP access method.
It will pull the repositories in a tree like structure same as on Gitlab or
Gitea.
It will pull the repositories in a tree like structure same as on Gitlab or Gitea.
```
root [http://gitlab.example.com]
├── group1 [/group1]
@ -23,78 +23,37 @@ root [http://gitlab.example.com]
└── subgroup3 [/group2/subgroup3]
```
# Example
Gitea:
```
$ ./gogitlabber -backend=gitea -destination=$HOME/Documents -git-url=gitea.example.com
-git-api-token=supersecrettoken
100% [====================] (30/30) [4s] ...
Summary:
Cloned repositories: 0
Pulled repositories: 30
Errors: 0
```
Gitlab:
```
$ ./gogitlabber -backend=gitlab -destination=$HOME/Documents -git-url=gitlab.example.com
-git-api-token=supersecrettoken
100% [====================] (30/30) [4s] ...
Summary:
Cloned repositories: 0
Pulled repositories: 30
Errors: 0
## Config file
GitLab:
```yaml
# ~/.config/gogitlabber/gitlab.example.com.yaml
debug: false
concurrency: 15
git_host: "gitlab.example.net"
git_token: "glpat-"
git_backend: "gitlab"
include_archived: "excluded"
destination: "$HOME/Documents"
```
# Usage
```
Usage of gogitlabber:
-archived string
To include archived repositories (any|excluded|exclusive)
example: -archived=any
env = GOGITLABBER_ARCHIVED
(default "excluded")
-backend string
Specify git backend
example: -backend=gitlab
env = GOGITLABBER_BACKEND
## Usage
-concurrency int
Specify repository concurrency
example: -concurrency=15
env = GOGITLABBER_CONCURRENCY
(default 15)
-debug
Toggle debug mode
example: -debug=true
env = GOGITLABBER_DEBUG
(default false)
-destination string
Specify where to check the repositories out
example: -destination=$HOME/repos
env = GOGITLABBER_DESTINATION
(default "$HOME/Documents")
-git-api-token string
Specify API token
example: -git-api=glpat-xxxx
env = GIT_API_TOKEN
(default "")
-git-url string
Specify Git host
example: -git-url=gitlab.example.com
env = GIT_URL
(default "gitlab.com")
```bash
gogitlabber -config=~/.config/gogitlabber/gitlab.example.com.yaml
```
# Access Token Permissions
## Gitea
## Access Token Permissions
### Gitea
Make sure the Gitea Access Token has at least the following permissions:
- user - read
- repository - read
## Gitlab
### Gitlab
Make sure the Gitlab Access Token has the `api` scope.