Gitlabber
- A Gitlab clone/pull tool to manage entire Gitlab trees (groups, subgroups, projects) *
Purpose
When working with large Gitlab setups you typically need a subset of the projects residing in groups of interest.
Gitlabber allows you to clone pull all projects under a subset of groups / subgroups.
Gitlabber builds a tree structure from the Gitlab server and allows you to specify which subset of the tree you want to clone using glob or regex expressions
This makes Gitlabber suitable for development environments or backups scenarios
Installation
- You can install gitlabber from PyPi :
pip install gitlabber
- You'll need to create an access token from Gitlab with API scopes read_repository and read_api
Usage
- Arguments can be provided via the CLI arguments directly or via environment variables::
Argument
Flag
Environment Variable
token
-t
GITLAB_TOKEN
url
-u
GITLAB_URL
method
-m
GITLABBER_CLONE_METHOD
include
-i
GITLABBER_INCLUDE
exclude
-x
GITLABBER_EXCLUDE
To view the tree run the command with your includes/excludes and the -p flag it will print your tree like so
root [http://gitlab.my.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]
- To see how to use glob patterns and regex to filter tree nodes see globre project page .
- Printed Usage:
usage: gitlabber [-h] [-t token] [-u url] [--verbose] [-p]
[--print-format {json,yaml,tree}] [-m {ssh,https}] [-i csv]
[-x csv] [--version]
[dest]
Gitlabber - clones or pulls entire groups/projects tree from gitlab
positional arguments:
dest destination path for the cloned tree (created if doesn't exist)
optional arguments:
-h, --help show this help message and exit
-t token, --token token
gitlab personal access token https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
-u url, --url url base gitlab url (e.g.: 'http://gitlab.mycompany.com')
--verbose print more verbose output
-p, --print print the tree without cloning
--print-format {json,yaml,tree}
print format (default: 'tree')
-m {ssh,http}, --method {ssh,http}
the method to use for cloning (either "ssh" or "http")
-i csv, --include csv
comma delimited list of glob patterns of paths to projects or groups to clone/pull
-x csv, --exclude csv
comma delimited list of glob patterns of paths to projects or groups to exclude from clone/pull
--version print the version
examples:
clone an entire gitlab tree using a base url and a token:
gitlabber -t <personal access token> -u <gitlab url>
# the following examples assume you provided token/url in environment variables so these arguments are omitted
only print the gitlab tree:
gitlabber -p .
clone only projects under subgroup 'MySubGroup' to location '~/GitlabRoot':
gitlabber -i '/MyGroup/MySubGroup**' ~/GitlabRoot
clone only projects under group 'MyGroup' excluding any projects under subgroup 'MySubGroup':
gitlabber -i '/MyGroup**' -x '/MyGroup/MySubGroup**' .
clone an entire gitlab tree except projects under groups named 'ArchiveGroup':
gitlabber -x '/ArchiveGroup**' .
clone projects that start with a case insensitive 'w' using a regular expression:
gitlabber -i '/{[w].*}' .
Debugging
- You can use the --verbose flag to get Gitlabber debug messages printed
- For more verbose gitlab messages you can get GitPython module to print more debug messages by setting the environment variable:
export GIT_PYTHON_TRACE='full'
Toubleshooting
- GitlabHttpError: 503: make sure you provide the base url to your gitalb installation (e.g., https://gitlab.my.com and not https://gitlab.my.com/some/nested/path)