Back to Desktop

Authenticating to Bitbucket with GitHub Desktop

docs/integrations/bitbucket.md

latest3.1 KB
Original Source

Authenticating to Bitbucket with GitHub Desktop

GitHub Desktop now provides support for Git Credential Manager (GCM), which makes the task of authenticating to Bitbucket repositories easy and secure. This feature can be enabled by going to File > Options > Advanced on Windows, or GitHub Desktop > Preferences > Advanced on macOS, and then selecting the Use Git Credential Manager checkbox.

When Git Credential Manager is enabled all credentials for Bitbucket will be handled, and stored, outside of GitHub Desktop. Git Credential Manager supports browser authentication and will avoid the need to create personal access tokens (PATs).

The prompt to authenticate to your Bitbucket account using GCM will be shown when you go to File > Clone Repository > URL and enter the HTTPS clone URL of the repository.

If you would prefer not to use GCM and need to create a personal access token in Bitbucket you can follow the steps below.

Creating a Personal Access Token in Bitbucket

To authenticate against Bitbucket repositories you will need to create a personal access token.

  1. Go to your Bitbucket account and select Personal Bitbucket settings in the settings dropdown.

  2. Select App passwords

  3. Under App passwords click Create app password

  1. Under the Details section in Add app password enter a label for your password

  2. Under Permissions select Read and Write in the Repositories section to ensure that GitHub Desktop has the correct read/write access to your Bitbucket repositories.

  3. Click Create to create a new token, and then copy the token to your clipboard.

Cloning your Bitbucket repository in GitHub Desktop

  1. Open GitHub Desktop and go to File > Clone Repository > URL. Enter the Git URL of your Bitbucket repository. Make sure you enter the correct URL, which should have the following structure:

    https://bitbucket.com/<username>/<repository>

  2. You will receive an Authentication Failed error. Enter your Bitbucket username and paste in the token you just copied to your clipboard as your password. Click Save and Retry to successfully clone the repository to your local machine in GitHub Desktop.

  • Note: Your Bitbucket credentials will be securely stored on your local machine so you will not need to repeat this process when cloning another repository from Bitbucket.