Usage¶
Manage a GitHub repo.
repo-helper github [OPTIONS] COMMAND [ARGS]...
Options
-
--version
¶
Show the version and exit.
Commands¶
new¶
Create a new GitHub repository for this project.
repo-helper github new [OPTIONS]
Options
-
--colour
,
--no-colour
¶
Whether to use coloured output.
-
-v
,
--verbose
¶
Show information on the GitHub API rate limit.
-
-t
,
--token
<token>
¶ Required The token to authenticate with the GitHub API. Can also be provided via the ‘GITHUB_TOKEN’ environment variable.
-
--org
¶
Indicates the repository belongs to the organisation configured as ‘username’ in repo_helper.yml.
Environment variables
-
GITHUB_TOKEN
Provides a default for
-t / --token
update¶
Update the GitHub repository for this project.
repo-helper github update [OPTIONS]
Options
-
--colour
,
--no-colour
¶
Whether to use coloured output.
-
-v
,
--verbose
¶
Show information on the GitHub API rate limit.
-
-t
,
--token
<token>
¶ Required The token to authenticate with the GitHub API. Can also be provided via the ‘GITHUB_TOKEN’ environment variable.
-
--org
¶
Indicates the repository belongs to the organisation configured as ‘username’ in repo_helper.yml.
Environment variables
-
GITHUB_TOKEN
Provides a default for
-t / --token
secrets¶
Set or update the secrets of the GitHub repository for this project.
repo-helper github secrets [OPTIONS]
Options
-
--colour
,
--no-colour
¶
Whether to use coloured output.
-
-v
,
--verbose
¶
Show information on the GitHub API rate limit.
-
-t
,
--token
<token>
¶ Required The token to authenticate with the GitHub API. Can also be provided via the ‘GITHUB_TOKEN’ environment variable.
-
--org
¶
Indicates the repository belongs to the organisation configured as ‘username’ in repo_helper.yml.
Environment variables
-
GITHUB_TOKEN
Provides a default for
-t / --token
labels¶
Create labels for this repository.
repo-helper github labels [OPTIONS]
Options
-
--colour
,
--no-colour
¶
Whether to use coloured output.
-
-v
,
--verbose
¶
Show information on the GitHub API rate limit.
-
-t
,
--token
<token>
¶ Required The token to authenticate with the GitHub API. Can also be provided via the ‘GITHUB_TOKEN’ environment variable.
-
--org
¶
Indicates the repository belongs to the organisation configured as ‘username’ in repo_helper.yml.
Environment variables
-
GITHUB_TOKEN
Provides a default for
-t / --token
Tokens¶
The token passed to the -t / --token
argument,
or set as the GITHUB_TOKEN
environment variable,
must have the following OAuth scopes:
public_repo
– Access public repositoriesworkflow
– Update github action workflowsread:org
– Read org and team membership, read org projects
For information on creating a personal access token please see the GitHub Documentation.