Skip to main content

This version of GitHub Enterprise was discontinued on 2023-01-18. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Creating a personal access token

You can create a personal access token to use in place of a password with the command line or with the API.

Warning: Treat your access tokens like passwords.

To access GitHub from the command line, consider using GitHub CLI or Git Credential Manager instead of creating a personal access token.

When using a personal access token in a script, consider storing your token as a secret and running your script through GitHub Actions. For more information, see "Encrypted secrets."

If these options are not possible, consider using another service such as the 1Password CLI to store your token securely.

About personal access tokens

Personal access token are an alternative to using passwords for authentication to GitHub Enterprise Server when using the GitHub API or the command line. Personal access tokens are intended to access GitHub resources on behalf of yourself. To access resources on behalf of an organization, or for long-lived integrations, you should use a GitHub App. For more information, see "About apps."

Creating a personal access token

  1. In the upper-right corner of any page, click your profile photo, then click Settings.

    Settings icon in the user bar

  2. In the left sidebar, click Developer settings. Developer settings

  3. In the left sidebar, click Personal access tokens. Personal access tokens

  4. Click Generate new token. Generate new token button

  5. Give your token a descriptive name. Token description field

  6. To give your token an expiration, select the Expiration drop-down menu, then click a default or use the calendar picker. Token expiration field

  7. Select the scopes you'd like to grant this token. To use your token to access repositories from the command line, select repo. A token with no assigned scopes can only access public information. For more information, see "Available scopes".

    Selecting token scopes

  8. Click Generate token. Generate token button

    Newly created token

Using a token on the command line

Once you have a token, you can enter it instead of your password when performing Git operations over HTTPS.

For example, on the command line you would enter the following:

$ git clone https://HOSTNAME/USERNAME/REPO.git
Username: YOUR_USERNAME
Password: YOUR_TOKEN

Personal access tokens can only be used for HTTPS Git operations. If your repository uses an SSH remote URL, you will need to switch the remote from SSH to HTTPS.

If you are not prompted for your username and password, your credentials may be cached on your computer. You can update your credentials in the Keychain to replace your old password with the token.

Instead of manually entering your personal access token for every HTTPS Git operation, you can cache your personal access token with a Git client. Git will temporarily store your credentials in memory until an expiry interval has passed. You can also store the token in a plain text file that Git can read before every request. For more information, see "Caching your GitHub credentials in Git."

Further reading