Auth Commands

Manage authentication with Bitbucket.

Global options available on all auth commands: --json, --no-color.

`bb auth login`

Authenticate with Bitbucket using an API token.

bb auth login [options]

Options

Option	Description
`-u, --username <username>`	Bitbucket username
`-p, --password <password>`	Bitbucket API token
`--json`	Output as JSON

Examples

# Login with credentials via command line
bb auth login -u myuser -p your-api-token

# Login using environment variables
export BB_USERNAME=myuser
export BB_API_TOKEN=your-api-token
bb auth login

How It Works

You provide your Bitbucket username and API token
The CLI stores the credentials securely in your config file
The CLI verifies the credentials by fetching your user information
If verification fails, credentials are not saved

Required Scopes

Your API token needs these scopes:

Account: Read (to verify your identity)
Repositories: Read, Write (depending on operations you’ll perform)
Pull requests: Read, Write (for PR operations)

See the Authentication guide for detailed setup instructions.

`bb auth logout`

Log out of Bitbucket and remove stored credentials.

bb auth logout [options]

Options

Option	Description
`--json`	Output as JSON

Examples

bb auth logout

What Gets Removed

This command removes only your stored credentials (username and apiToken) from the config file. Other settings like defaultWorkspace, skipVersionCheck, and versionCheckInterval are preserved.

`bb auth status`

Show current authentication status and account information.

bb auth status [options]

Options

Option	Description
`--json`	Output as JSON

Examples

# Check authentication status
bb auth status

# Get status as JSON
bb auth status --json

Output

When authenticated:

✓ Logged in to Bitbucket
  Username: myuser
  Display name: My Name
  Account ID: 123456789

When not authenticated:

ℹ Not logged in
Run bb auth login to authenticate.

`bb auth token`

Print the current access token (base64 encoded credentials).

bb auth token [options]

Options

Option	Description
`--json`	Output as JSON

Examples

# Print the token
bb auth token

# Get token as JSON
bb auth token --json

Use Cases

This is useful for:

Debugging authentication issues
Using the token with other tools or scripts
Verifying token format