ghorg
ghorg allows you to quickly clone all of an orgs, or users repos into a single directory. This can be useful in many situations including
- Searching an orgs/users codebase with ack, silver searcher, grep etc..
- Bash scripting
- Creating backups
- Onboarding
- Performing Audits
When running ghorg a second time, all local changes in your *_ghorg directory will be overwritten by whats on GitHub. If you are working out of this directory, make sure you rename it before running a second time otherwise all of your changes will be lost.
Supported Providers
- GitHub
- GitLab
- Bitbucket
- Gitea
The terminology used in ghorg is that of GitHub, mainly orgs/repos. GitLab and BitBucket use different terminology. There is a handy chart thanks to GitLab that translates terminology here
Install
Homebrew
optional
$ brew update
$ brew upgrade git
required
$ brew install gabrie30/utils/ghorg
$ mkdir -p $HOME/.config/ghorg
$ curl https://raw.githubusercontent.com/gabrie30/ghorg/master/sample-conf.yaml > $HOME/.config/ghorg/conf.yaml
$ vi $HOME/.config/ghorg/conf.yaml # (optional but recommended)
Golang
# ensure $HOME/go/bin is in your path ($ echo $PATH | grep $HOME/go/bin)
$ go get github.com/gabrie30/ghorg
$ mkdir -p $HOME/.config/ghorg
$ curl https://raw.githubusercontent.com/gabrie30/ghorg/master/sample-conf.yaml > $HOME/.config/ghorg/conf.yaml
$ vi $HOME/.config/ghorg/conf.yaml # (optional but recommended)
Use
# note: to view/set all available flags/features see sample-conf.yaml and for more examples see ./examples
$ ghorg clone someorg
$ ghorg clone someorg --concurrency=50 --token=bGVhdmUgYSBjb21tZW50IG9uIGlzc3VlIDY2
$ ghorg clone someuser --clone-type=user --protocol=ssh --branch=develop --color=off
$ ghorg clone gitlab-group --scm=gitlab --base-url=https://gitlab.internal.yourcompany.com --preserve-dir
$ ghorg clone gitlab-group/gitlab-subgroup --scm=gitlab --base-url=https://gitlab.internal.yourcompany.com
$ ghorg clone --help
# view cloned resources
$ ghorg ls
$ ghorg ls someorg
Setup and Configuration
Configuration for each clone can be set in two ways. The first is in $HOME/.config/ghorg/conf.yaml. This file should be created from the sample-conf.yaml by copying into $HOME/.config/ghorg/conf.yaml. The second method of configuration is setting flags via the cli, run $ ghorg clone --help for a list of flags. A flag set on the command line will overwrite any setting in the conf.yaml
github setup
- Create Personal Access Token with all
reposcopes. UpdateGHORG_GITHUB_TOKENin yourghorg/conf.yaml, as a cli flag, or add to your osx keychain.
gitlab setup
- Create Personal Access Token with the
read_apiscope (orapifor self-managed GitLab older than 12.10). This token can be added to yourghorg/conf.yaml, as a cli flag, or your osx keychain. - Update the
GitLab Specificconfig in yourghorg/conf.yamlor via cli flags - Update
GHORG_SCM_TYPEtogitlabin yourghorg/conf.yamlor via cli flags - See examples/gitlab.md on how to run
gitea setup
- Create Access Token (Settings -> Applications -> Generate Token)
- Update
GHORG_GITEA_TOKENin yourghorg/conf.yamlor use the (--token, -t) flag. - Update
GHORG_SCM_TYPEtogiteain yourghorg/conf.yamlor via cli flags
bitbucket setup
- To configure with bitbucket you will need to create a new app password and update your
$HOME/.config/ghorg/conf.yamlhere or use the (--token, -t) and (--bitbucket-username) flags. - Update SCM type to
bitbucketin yourghorg/conf.yamlor via cli flags
osx default github/gitlab token used
NOTE: cloning via https rather than ssh is the ghorg default, this is because a token must be present to retreive the list of repos. However, if you run into trouble cloning via https and genearlly clone via ssh, try switching
--protocol ssh
$ security find-internet-password -s github.com | grep "acct" | awk -F\" '{ print $4 }'
$ security find-internet-password -s gitlab.com | grep "acct" | awk -F\" '{ print $4 }'
It's recommended to store github/gitlab tokens in the osxkeychain, if this command returns anything other than your token see Troubleshooting section below. However, you can always add your token to the $HOME/.config/ghorg/conf.yaml or use the (--token, -t) flags.
Ignoring Repos
-
To ignore any archived repos while cloning use the
--skip-archivedflag (not bitbucket) -
To ignore specific repos create a
ghorgignorefile inside$HOME/.config/ghorg. Each line in this file is considered a substring and will be compared against each repos clone url. If the clone url contains a substring in theghorgignoreit will be excluded from cloning. To prevent accidentally excluding a repo, you should make each line as specific as possible, eg.https://github.com/gabrie30/ghorg.gitor[email protected]:gabrie30/ghorg.gitdepending on how you clone.# Create ghorgignore touch $HOME/.config/ghorg/ghorgignore # update file vi $HOME/.config/ghorg/ghorgignore
Known issues
-
When cloning if you see something like
Username for 'https://gitlab.com':the command won't finish. I haven't been able to identify the reason for this occuring. The fix for this is to make sure your token is in the osxkeychain. See the troubleshooting section for how to set this up, or try cloning via ssh (--protocol=ssh). -
If you are cloning a large org you may see
Error: open /dev/null: too many open fileswhich means you need to increase your ulimits, there are lots of docs online for this. For mac the quick and dirty is below# reset the soft and hard file limit boundaries $ sudo launchctl limit maxfiles 65536 200000 # actually now set the ulimit boundary $ ulimit -n 20000Another solution is to decrease the number of concurrent clones. Use the
--concurrencyflag to set to lower than 25 (the default)
Troubleshooting
- If the
securitycommand does not return your token, follow this GitHub Documentation. For GitHub tokens you will need to set your token as your username and set nothing as the password when prompted. For GitLab you will need to set your token for both the username and password when prompted. This will correctly store your credentials in the keychain. If you are still having problems see this StackOverflow Post - If your GitHub account is behind 2fa follow this Github Documentation
- GitHub Personal Access Token only finding public repos - Give your token all the repo permissions
- Make sure your
$ git --versionis >= 2.19.0
