Getting Started with BitSlug

Follow this step-by-step guide to set up your Bitrise API token and start monitoring your builds with BitSlug.

1

Get API Token

Create your Personal Access Token or Workspace API Token from Bitrise

2

Download BitSlug

Install the native macOS application from our releases page

3

Configure & Monitor

Add your token to BitSlug and start monitoring your builds

Choose Your Token Type

Personal Access Token

Recommended for individual developers

Access to all your personal apps
Easy to set up and manage
Full control over permissions
Get Personal Token

Workspace API Token

For team and organization use

Access to workspace apps
Shared across team members
Granular permissions control
Get Workspace Token

Personal Access Token Setup

1

Login to Bitrise

Go to app.bitrise.io and log in to your Bitrise account.

2

Navigate to Account Settings

Click on your profile picture in the top right corner, then select "Account settings" from the dropdown menu.

3

Go to Security Tab

In the Account settings page, click on the "Security" tab in the left sidebar.

4

Generate New Token

In the "Personal Access Tokens" section, click "Generate new token". Give your token a descriptive name like "BitSlug App".

5

Copy Your Token

After clicking "Generate", copy the generated token immediately. ⚠️ You won't be able to see it again!

Workspace API Token Setup

1

Access Workspace Settings

In your Bitrise dashboard, navigate to your workspace and click on "Workspace settings" in the left sidebar.

2

Go to Security Section

In the workspace settings, find and click on the "Security" or "API" section.

3

Create API Token

Click "Generate new API token" and provide a descriptive name like "BitSlug Team Access".

4

Set Permissions

Configure the appropriate permissions for the token. For BitSlug, you'll typically need:

  • Read access to apps and builds
  • Read access to build logs (optional)
  • Trigger builds (if you want to start builds from BitSlug)
5

Save Your Token

Copy the generated token immediately and store it securely. ⚠️ This is your only chance to copy it!

Configure BitSlug

1

Download BitSlug

If you haven't already, download BitSlug from our releases page.

Download Latest Release
2

Launch BitSlug

Open the BitSlug application. On first launch, you'll be prompted to add your Bitrise API token.

3

Add Your Token

Paste your Personal Access Token or Workspace API Token into the designated field. BitSlug will securely store it in your macOS Keychain.

4

Verify Connection

BitSlug will test the connection to Bitrise and display your apps and builds. You're now ready to start monitoring your CI/CD workflows!

Security Best Practices

Never share your API tokens with anyone or include them in code repositories.

Regularly rotate your tokens as part of good security hygiene.

Use minimal permissions - only grant the access levels your workflow requires.

BitSlug stores tokens securely in your macOS Keychain with encryption.

Troubleshooting

"Invalid token" or "Authentication failed"

Causes:

  • Token was copied incorrectly (extra spaces or characters)
  • Token has been revoked or expired
  • Wrong token type for your access level

Solutions:

  • Double-check the token by generating a new one
  • Make sure you're using the correct token type
  • Verify your Bitrise account has the necessary permissions

"No apps found" or empty app list

Causes:

  • Token doesn't have access to any apps
  • Using Personal token but apps are in a workspace
  • Network connectivity issues

Solutions:

  • Try using a Workspace API Token instead
  • Check your Bitrise account has apps in it
  • Verify your internet connection

Ready to Get Started?

Now that you have your token, download BitSlug and start monitoring your Bitrise builds with a native macOS experience.

Download BitSlug Get Help