Tutorial: Getting started with Git in CLion

1. Launch CLion and click New Project on the Welcome screen.

   tip

   If you have another project open in CLion at the moment, select File | New Project from the main menu.

2. In the dialog that opens, select the project type (for example, C++ Executable), provide the location path and set the language standard. Click Create.

   

3. The new project will immediately open in CLion:

   

1. Go to VCS | Enable Version Control Integration.

2. In the dialog that opens, select Git from the list of available version control systems and click OK.

   

Alternatively, press Alt0` and select Create Git Repository (or press 1). In the Finder window that opens, specify a root folder for the local Git repository.

1. Group the files by directories: press CtrlAlt0P or click on the toolbar and select Directory.

   

2. Select the directories that you don't want to share. For example, the following directories may be ignored without breaking the integrity of the project:

   • .idea: settings of your local CLion installation. Ignore this directory unless you want to share your settings among the team members.

     note

     Generally, it's not recommended that you put the entire contents of .idea under gitignore. See this instruction for more details.

   • cmake-build-debug: the automatically created directory for CMake build artifacts.

3. Right-click the selection and choose Add to .gitignore | Add to .gitignore.

   

4. You will be prompted to confirm the creation of a new .gitignore file in the root directory of your project. Click Create.

5. From the dialog that opens, you can either add the newly created file to Git right away by pressing Add or postpone this by pressing Cancel.

   Click Add. You will see that the .gitignore file has been added to the root directory of your project and placed to Changes area. The directories you selected to ignore are no longer displayed in the Unversioned Files list:

   

   Any time, you can edit the .gitignore file to add new directories to the list or remove existing ones.

   tip

   To show the ignored files again, click on the toolbar.

1. In the Commit tool window Alt00, move all the files from the Unversioned Files list to Changes using drag-and-drop. Select all the files by clicking the root folder checkbox.

   tip

   From the Commit tool window Alt00, you can also preview added and modified files, use the advanced commit options, add and exclude files from the commit, and more.

2. Type a message for your first commit:

   

3. Click Commit. The corresponding notification appears once the commit is performed:

   

1. Go to VCS | Share Project on GitHub.

2. In the dialog that opens, enter your GitHub login and password and click Log In:

   

   If you are not registered on GitHub, click Sign up for GitHub to go to github.com and create a new account there.

   tip

   You can change the GitHub account or add a new one in Preferences | Version Control | GitHub. See more in Manage multiple GitHub accounts.

3. If you have two-factor authentication enabled for GitHub, the following dialog will appear:

   

   Enter the code and click OK.

4. In the dialog that opens, you can change the repository name (by default, it is the same as the project name), the name of a remote (by default, origin), choose the repository type (public or private), and add some description if needed:

   

   Click Share. After the project is successfully published on GitHub, the following notification will appear:

   

   Click the link in the notification to open the repository on GitHub.

tip

You can edit the list of remotes in the Git Remotes dialog. To open the dialog, select Git | Manage Remotes) from the main menu.

1. Press Ctrl0T to pull the latest version of the current branch.

2. On the status bar, you can see your current branch — master. Click it to open the Git Branches menu:

   

3. From the Git Branches menu, select New Branch.

4. In the dialog that opens, specify the branch name, for example, new_feature, and select the Checkout branch checkbox to switch to the new branch right away.

   

   tip

   If there are some unversioned changes in the current branch, you need to commit, revert, or shelve them before switching to another branch. See more in Switch between branches.

   Now you are switched to the newly created branch:

   

5. Add the corresponding branch to the remote repository. To do this, select the local branch in the Git Branches menu and click Push:

   

   In the dialog that opens, click Push. The new branch will be added to the remote repository and will appear in the Remote Branches list in the Git Branches menu:

   

1. Press Ctrl0T to pull the latest version of the current branch.

2. Add a new file to the project, for example, subfunc.cpp, and modify the main.cpp file.

   In the Project tool window and in the editor tabs, CLion applies different colors to files: blue to modified, green — to newly added. Moreover, in the gutter area of a modified file, the colored change markers appear next to the modified lines. You can click the gutter marker to view details:

   

3. Click to view the difference in a separate window:

   

4. Go to the Commit tool window Alt00, to preview all the changes at once. Double-click a file to open the difference view in the editor:

   

   See more in Review changes.

1. Press Ctrl0T to pull the latest version of the current branch.

2. In the Commit tool window Alt00, review the changes, make sure that the new file that you're adding to Git is selected, type the commit message, and click Commit.

   tip

   When typing the commit message, you can use auto-completion for the project file names CtrlSpace:

   

3. Press CtrlShift0K or select Git | Push from the main menu to push the changes to the remote repository. The Push Commits dialog opens. Here you can see all the commits to be pushed as well as all the affected files. Before pushing the changes, you can see the differences for each file. To do this, right-click a file and select Show Diff or press Ctrl0D:

   

4. Click Push.

   tip

   To revert a pushed commit, right-click it on the Log tab of the Git tool window Alt09 and select Revert commit. For more information, refer to Revert a pushed commit.

1. Select the master branch in the Git Branches menu on the status bar and click Checkout.

   tip

   If there are some unversioned changes in the current branch, you need to commit, revert, or shelve them before switching to another branch. See more in Switch between branches.

2. Make some changes in main.cpp that has been modified before in the new_feature branch, for example:

   

   This way, we simulate a conflict situation. Push and commit the change as described above.

3. From the Git Branches menu, select new_feature and click Merge into Current.

1. In the Conflicts dialog, you have several options to resolve the conflict:

   • Accept Yours: keep the changes made in the current branch.

   • Accept Theirs: apply the changes from the branch that you want to merge into the current one.

   • Merge: resolve conflicts manually in a dedicated dialog.

   Click Merge. The Merge Revisions dialog opens:

   

2. In this dialog, you can accept changes by clicking /, decline them by clicking , and type code in the Result pane. See more in Resolve Git conflicts.

   The syntax errors are highlighted in the Merge Revisions window:

   

   Resolve the conflict as on the screenshot above and click Apply.

3. Push the changes to the remote repository by pressing CtrlShift0K or selecting Git | Push from the main menu.

• Right-click the file in the editor or in the Project tool window Alt01 and select Git | Show History. The History tab of the Git tool window opens:

  

  On this tab you can view all commits that affected the file and find out in which commit the change of your interest was added.

• In the editor, select a code fragment you want to view history for, right-click the selection, and choose Git | Show History for Selection. The History for Selection window will open:

  

  Here you can review all the commits that affected the code selection of your interest.

1. In the master branch, make a change that you are going to cherry-pick. Commit Ctrl0K and push CtrlShift0K this change.

2. Switch to the new_feature branch.

3. In the Git tool window Alt09, open the Log tab.

4. In the Branch list, select master.

5. Select your last commit and click :

   

6. Resolve the conflict by pressing Accept Theirs form the dialog that opens. This means we override the code in the main.cpp file by the changes from the cherry-picked commit.

7. Commit the changes from the Commit Changes dialog that opens and push them CtrlShift0K.

   

   note

   If no conflicts emerge, the cherry-pick will be committed automatically, and you will just need to push the changes.