With the Git integration enabled, you can perform basic Git operations from inside PyCharm.
The information provided in the topics listed below assumes that you are familiar with the basics of Git version control system.
In this section:
- Using Git Integration
- Adding Files to a Local Git Repository
- Adding Tags
- Checking Git Project Status
- Committing Changes to a Local Git Repository
- Fetching Changes from a Remote Git Repository
- Handling Passwords for Git Remote Repositories
- Managing Branches
- Setting up a Local Git Repository
- Stashing and Unstashing Changes
- Pulling Changes from the Upstream (Git Pull)
- Pushing Changes to the Upstream (Git Push)
- Handling LF and CRLF Line Endings
Git is installed on your computer.
It is strongly recommended that you use version 184.108.40.206 or higher.
- The location of the Git executable file is correctly specified on the Git page of the Settings dialog box.
- Git integration is enabled for the current project root or directory.
If you are going to use a remote repository, create a Git hosting account first.
You can access the remote repository through the username/password and keyboard interactive authentication methods supported by the Git integration
or through a pair of ssh keys.
Please note the following:
- ssh keys are generated outside PyCharm. You can follow the instructions from https://help.github.com/articles/generating-ssh-keys/ or look for other guidelines.
Store the ssh keys
in the home_directory
The location of the home directory
is defined through environmental variables:
- HOME for Unix-like operating systems.
- userprofile for the Microsoft Windows operating system.
Make sure, the keys are stored in files with correct names:
- id_rsa for the private key.
- id_rsa.pub for the public key.
- PyCharm supports a standard method of using multiple ssh keys, by means of creating .ssh/config file.
- When the Git integration with PyCharm is enabled, the item appears on the menu, and on the context menus of the Editor and Project views.
- The files in the folders under the Git control are highlighted according to their status. See File Status Highlights for file status highlighting conventions.
- Results of modifications show in the Changes tool window.
- When using the Git integration, it is helpful to open the Version Control tool window.
Its Console tab displays the following data:
- All the commands generated based on the settings you specify through the PyCharm user interface.
- Information messages concerning the results of executing generated Git commands.
- Error messages.