Skip to content

Authentication

GitHub Organization Tools requires authentication to access the GitHub API.

Personal Access Tokens

GitHub Organization Tools uses Personal Access Tokens to authenticate with the GitHub API.

The scopes required for the token depend on the actions you want to perform.

Required Scopes

The following scopes are required for the different available commands:

Storing the Token

GitHub Organization Tools can store the token in the system keyring if the user allows it when prompted to do so.

Enter your GitHub Personal Access Token: <token>
Save this token for future use? (y/n): y

Checking Authentication

You can check if you are authenticated by running the following command:

ghot auth check

If not authenticated, you will be prompted to enter your GitHub Personal Access Token.

Removing the Token

You can remove the token from the keyring by running the following command:

ghot auth remove

Printing the Token

You can print the token to the console by running the following command:

ghot auth print