RepoBee does not have to be configured as all arguments can be provided on the command line, but doing so becomes very tedious, very quickly. It’s typically a good idea to at least configure the OAUTH token, as well as the GitHub base url (for the API) and your GitHub username (see Configuration file).
The RepoBee User Guide expects there to be a configuration file as described in Getting started (the show-config, verify-settings and setup commands).
For repobee to work at all, it needs access to an OAUTH token. See the GitHub
OAUTH docs for how to create a token. Make sure that it has the
admin:org permissions. There are two ways to hand the token to repobee:
- Put it in the
REPOBEE_OAUTHenvironment variable. - On a unix system, this is as simple as
- Put it in the configuration file (see Configuration file).
An optional configuration file can be added, specifying defaults for several of the most frequently used cli options line options. This is especially useful for teachers ant TAs who are managing repos for a single course (and, as a consequence, a single organization).
[DEFAULTS] base_url = https://some-api-v3-url user = YOUR_USERNAME org_name = ORGANIZATION_NAME master_org_name = MASTER_ORGANIZATION_NAME students_file = STUDENTS_FILE_ABSOLUTE_PATH token = SUPER_SECRET_TOKEN
If the configuration file exists, it must contain the
header. This is to minimize the risk of misconfiguration by novice users.
To find out where to place the configuration file (and what to name it),
repobee show-config. The configuration file can also be used to
repobee plugins. See the Using Existing Plugins section for more
Do note that the configuration file contains only default values. Specifying any of the parameters on the command line will override the configuration file’s values.
You can run
repobee verify-settings to verify the basic configuration.
This will check the most important settings configurable in