Buildkite CLI configuration

The Buildkite CLI uses both the REST and GraphQL APIs to interact with Buildkite, and therefore, requires the configuration of an API access token.

Create an API access token for the Buildkite CLI

To create a new API access token:

Select your user profile icon > Personal Settings in the global navigation.
Select API Access Tokens to access your API Access Tokens page.
Select New API Access Token to open the New API Access Token page.
Specify a Description and the Organization Access (that is, the specific Buildkite organization) for this token.
Once you have selected the required REST API Scopes and Enable GraphQL API access for the token, retain a copy of your API access token's value in a secure location.

Note: You can also use the following New API Access Token page links with pre-set fields to create these API access tokens:

New API access token with description—pre-sets the Description field with Buildkite CLI.
New API access token with description and API scopes—pre-sets the Description field with Buildkite CLI, along with all the required REST API Scopes and Enable GraphQL API access options already selected.

If you use one of these links, you must still specify the Buildkite organization (in Organization Access) for this API access token.

Once you have created your API access token, you'll need to configure the Buildkite CLI with this token.

To do this:

Run the following command:
```
bk configure
```
When prompted for Organization slug, specify the slug for your Buildkite organization.
When prompted for API Token, specify the value for your configured API access token.

Some users may have access to Buildkite organizations—one for their company, and others for open-source work, personal work, etc.

The Buildkite CLI tool allows you to work with such multiple Buildkite organizations.

To configure the Buildkite CLI tool with another Buildkite organization:

Ensure you have created individual API access tokens for each Buildkite organization to configure in the Buildkite CLI tool.
Run the following command:
```
bk configure add
```
When prompted for Organization slug, specify the slug for the new Buildkite organization to add to the Buildkite CLI.
When prompted for API Token, specify the value for your configured API access token for this organization.

If your Buildkite CLI tool has been configured with multiple Buildkite organizations, you can switch from your current/active organization to another. To do this:

Run the following command:
```
bk use
```
Use the cursor select another configured Buildkite organization and make it the current/active one. All subsequent bk commands will operate with the new active organization.