sample-conf.yaml

---
# +-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
# |G|I|T|H|U|B| |S|P|E|C|I|F|I|C|
# +-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+

# Add your GitHub token
# Defaults to using key returned by
# $ security find-internet-password -s github.com  | grep "acct" | awk -F\" '{ print $4 }'
# flag (--token, -t) eg: --token=bGVhdmUgYSBjb21tZW50IG9uIGlzc3VlIDY2
GHORG_GITHUB_TOKEN:

# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
# |G|I|T|L|A|B| |S|P|E|C|I|F|I|C|
# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

# Add your GitLab token
# Defaults to using key returned by
# $ security find-internet-password -s gitlab.com  | grep "acct" | awk -F\" '{ print $4 }'
# flag (--token, -t) eg: --token=bGVhdmUgYSBjb21tZW50IG9uIGlzc3VlIDY2
GHORG_GITLAB_TOKEN:

# clones repos in a directory structure that matches gitlab namespaces eg company/unit/subunit/app would clone into */unit/subunit/app
# default: false
# flag (--preserve-dir)
GHORG_PRESERVE_DIRECTORY_STRUCTURE:

# +-+-+-+-+-+ +-+-+-+-+-+-+-+-+
# |G|I|T|E|A| |S|P|E|C|I|F|I|C|
# +-+-+-+-+-+ +-+-+-+-+-+-+-+-+

# Add your Gitea token
# Settings -> Applications -> Generate Token
# flag (--token, -t) eg: --token=bGVhdmUgYSBjb21tZW50IG9uIGlzc3VlIDY2
GHORG_GITEA_TOKEN:

# +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
# |B|I|T|B|U|C|K|E|T| |S|P|E|C|I|F|I|C|
# +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+

# Add your Bitbucket app password
# https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html
# flag (--token, -t) eg: --token=bGVhdmUgYSBjb21tZW50IG9uIGlzc3VlIDY2
GHORG_BITBUCKET_APP_PASSWORD:

# flag (--bitbucket-username)
GHORG_BITBUCKET_USERNAME:

# +-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+-+-+-+-+
# |G|E|N|E|R|A|L| |C|O|N|F|I|G|U|R|A|T|I|O|N|
# +-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+-+-+-+-+

# Change SCM base url, for on self hosted instances (for gitlab, use format of https://git.mydomain.com/api/v3), gitea require this
# default: uses github/gitlab public api
# flag (--base-url)
GHORG_SCM_BASE_URL:

# Which provider to clone from (github, gitlab, gitea or bitbucket)
# default: github
# flag (--scm, -s)
GHORG_SCM_TYPE:

# How you'd like to clone the repos (https or ssh)
# default: https
# flag (--protocol)
GHORG_CLONE_PROTOCOL:

# This is where your  directory will be created, use absolute pathing, shell expansions will not work
# default: YOUR_HOME_DIR/Desktop/ghorg
# flag (--path, -p)
GHORG_ABSOLUTE_PATH_TO_CLONE_TO:

# Branch ghorg resets and leaves checked out
# default: default branch
# NOTE: if no default branch is found on the repo, will fallback to using master
# flag (--branch, -b)
GHORG_BRANCH:

# Type of entity to clone (user or org)
# default: org
# to clone all of your own repos from github don't specify any user eg. "ghorg clone --clone-type=user --output-dir=personal"
# flag (--clone-type, -c)
GHORG_CLONE_TYPE:

# Color output (on, off)
# default: on
# flag (--color)
GHORG_COLOR:

# A comma separated list of topics to filter by, currently github/gitea only
# Defaults to ""
# If any topics exist here, ghorg will only clone repos that match at least one of these topics
GHORG_TOPICS:

# Skip archived repos (true/false), currently github/gitlab/gitea only
# default: false
# flag (--skip-archived)
GHORG_SKIP_ARCHIVED:

# Skip repos that are forks (true/false), currently github/gitlab/gitea only
# default: false
# flag (--skip-forks)
GHORG_SKIP_FORKS:

# Backup mode, clone as mirror, no working copy (ignores branch parameter) (true/false)
# default: false
# flag (--backup)
GHORG_BACKUP:

# Max goroutines created while cloning
# default: 25
# flag (--concurrency)
GHORG_CONCURRENCY:

# Folder ghorg will clone all repos into, will force underscores. Cloning will result in: GHORG_ABSOLUTE_PATH_TO_CLONE_TO/GHORG_OUTPUT_DIR/*
# default: {org/user you are cloning}
# flag (--output-dir)
GHORG_OUTPUT_DIR:

# Only clone repos with matching prefix, can be a comma separated list
# default: ""
# flag (--match-prefix)
GHORG_MATCH_PREFIX: