How to Create an Access Token

Guide on creating an access token for interacting with GitHub for authentication when using Aviator StackedPRs CLi.

GitHub Personal Access Token

If GitHub CLI is installed and set up on your computer, av CLI automatically uses the same credential for interacting with GitHub. Alternatively, you can create a personal access token (classic) to authenticate with GitHub on your behalf.

  1. Create a name and expiration for your token.

    • The generated token should have the repo scope (all other scopes can be left un-checked).

Required permissions for the GitHub personal access token that you will use with av

Put the created Personal Access Token in ~/.av/config.yaml.

~/.av/config.yaml
github:
    token: "ghp_abcdefghijklmnop"

Aviator User Access Token

User Access Tokens are used to authenticate with the Aviator REST API and Aviator GraphQL API.

  1. Create a name and expiration for your token.

    • The token should be in the format av_uat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx. Add it to your Aviator configuration file ~/.av/config.yaml as shown below.

~/.av/config.yaml
aviator:
    apiToken: "av_uat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

You can verify that your token works with av auth.

$ av auth
Logged in to GitHub as <your_email>.

Last updated

Was this helpful?