WebStorm 2021.1 Help

GitHub

WebStorm lets you manage Git projects hosted on GitHub directly from the IDE: clone repositories, share your projects, create forks, share code through gists, create pull requests and review incoming pull requests.

Register a GitHub account

To be able to retrieve data from a repository hosted on GitHub, or share your projects, you need to register your GitHub account in WebStorm.

Register an existing account

  1. Press Ctrl+Alt+S to open IDE settings and select Version Control | GitHub.

  2. Click the Add button.

  3. In the dialog that opens, specify your GitHub server URL (either github.com, or an enterprise instance).

  4. Do one of the following:

    • If you already have a token, click the Use Token link and paste it there.

    • If you want to obtain a new token, enter your login and password. If you have two-factor authentication enabled, you will be asked to enter a code that will be sent to you by SMS or through the mobile application. See Creating a personal access token for more details on GitHub tokens.

    The token must have the repo, the gist and the read:org scopes enabled in your account permissions (see Understanding scopes).

Create a new GitHub account

  1. Press Ctrl+Alt+S to open IDE settings and select Version Control | GitHub.

  2. Click Add account, and in the dialog that opens, click Sign up for Github.

  3. Register your account on the Sign up for GitHub page that opens.

  4. Return to the WebStorm settings and specify your credentials.

Manage multiple accounts

You can use multiple GitHub accounts in WebStorm: for example, a personal account to work on an open-source project, and a corporate account for your main job.

  1. Press Ctrl+Alt+S to open IDE settings and select Version Control | GitHub.

  2. Use the add icon button to add as many accounts as you need.

  3. (Optional) To set an account as a default one for the current project, select it and click the Check button. If a default account is set, WebStorm will not ask you to select an account you want to use when you share your project on GitHub, rebase a fork, create a pull request, or create a gist.

Last modified: 30 June 2021