Manage projects hosted on GitHub
Last modified: 27 September 2022Check out a project (clone)
You can clone a repository that you want to contribute to directly from PyCharm and create a new project based on it.
From the main menu, choose Git | Clone. If the Git menu is not available, choose VCS | Get from Version Control.
In the Get from Version Control dialog, choose GitHub on the left.
Log in to GitHub by doing one of the following:
If you have a token, click Use token, then paste the token in the Token field, and click Log In.
Otherwise, click Log In via GitHub.
Enter your GitHub credentials in the browser window that opens. 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.
Select a repository from the list of all GitHub projects associated with your account and the organization that your account belongs to.
In the Directory field, enter the path to the folder where your local Git repository will be created.
Click Clone.
If you want to create a project based on these sources, click Yes in the confirmation dialog. PyCharm will automatically set Git root mapping to the project root directory.
Share a project on GitHub
You can add a remote GitHub repository for a project you are developing locally, so that others can view it or contribute to it.
Open the project you want to share.
From the main menu, choose Git | GitHub | Share Project on GitHub.
If you have already registered your GitHub account in PyCharm, connection will be established using these credentials.
If you have not registered your account in PyCharm, the Login to GitHub dialog opens. Specify your access token or request a new one with your login and password.
When connection to GitHub has been established, the Share Project on GitHub dialog opens. Specify the new repository name, the name of the remote , and enter a description of your project.
You can select the Private option if you do not want to allow public access to your repository for other GitHub users.
Click Share to initiate a new repository and upload project sources to it.
Jump to the GitHub version of a file
You can jump from PyCharm to the GitHub version of a file. PyCharm detects which branch is currently active as well as the latest revision of the file, and opens the GitHub copy of the selected file in the corresponding commit in your web browser. If you are opening the GitHub file version from the editor, the file will be also automatically scrolled to the current line.
Select Git | GitHub | Open on GitHub from the main menu.
Select a file in the editor or in the Project view, and choose Open In | GitHub from the context menu.
Select the file in the Project view, press Ctrl+Shift+A, and type
Open on Github.
The remote version of the file will open in the browser.
If the file points to more than one remote, you will be prompted to select the appropriate repository.
Thanks for your feedback!