From e1e8892501ec21f43e38667afe91b861d0eec429 Mon Sep 17 00:00:00 2001 From: Simon Cornet Date: Thu, 3 Apr 2025 16:36:26 +0200 Subject: [PATCH] docs: improved readme --- readme.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 6fa24f1..26ad82a 100644 --- a/readme.md +++ b/readme.md @@ -6,6 +6,17 @@ It is mainly to learn Golang. But also to make something that specifically solve 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. +It will pull the repositories in a tree like structure same as on Gitlab. +root [http://gitlab.example.com] +├── group1 [/group1] +│ └── subgroup1 [/group1/subgroup1] +│ └── project1 [/group1/subgroup1/project1] +└── group2 [/group2] + ├── subgroup1 [/group2/subgroup1] + │ └── project2 [/group2/subgroup1/project2] + ├── subgroup2 [/group2/subgroup2] + └── subgroup3 [/group2/subgroup3] + # Usage ``` @@ -32,17 +43,17 @@ Usage of gogitlabber: Specify where to check the repositories out example: -destination=$HOME/repos env = GOGITLABBER_DESTINATION - (default "/home/simon/Documents/siempie") + (default "$HOME/Documents") -gitlab-api-token string Specify GitLab API token example: -gitlab-api=glpat-xxxx env = GITLAB_API_TOKEN - (default "glpat-QsUyRLKF3wPb1Ny7MLjy") + (default "") -gitlab-url string Specify GitLab host - example: -gitlab-url=gitlab.com + example: -gitlab-url=gitlab.example.com env = GITLAB_URL - (default "gitlab.simoncor.net") + (default "gitlab.com") ```