Quick start guide
0. Before you start
Is CLion a cross-platform IDE?
Yes, you can install and run CLion on Windows, macOS, and Linux.
What compilers and debuggers can I work with?
CLion supports debugging with GDB (either bundled or custom) on all platforms and with the bundled LLDB on macOS and Linux. Also, there is an LLDB-based debugger for the MSVC toolchain on Windows. For more information, refer to the section on debugging and to the Debugger options page.
What build systems are supported? What are the project formats?
CLion fully integrates with the CMake build system: you can create, open, build and run/debug CMake projects seamlessly. CMake itself is bundled in CLion, so you don't need to install it separately unless you decide to use a custom version.
For more information, refer to Project Formats.
Do I need to install anything in advance?
On Windows, CLion requires a working environment. CLion bundles a version of the MinGW toolset for quick setup. You can use this bundled toolchain or switch to another MinGW installation, Cygwin, or Microsoft Visual C++. If you are working with WSL or Docker, you will need to install them as well.
For more information, refer to our Windows tutorial.
On macOS, the required tools might be already installed. If not, update command line developer tools as described in Configuring CLion on macOS.
Are languages other that C++ supported as well?
1. Open/create a project
Open a local project
Use one of the following options:
Select File | Open and locate the project directory.
This directory should contain a CMakeLists.txt file.
Select File | Open and point CLion to the top-level CMakeLists.txt file, then click Open as Project.
Select File | Open and locate the CMakeCache.txt file, then click Open as Project.
Selectfrom the main menu.
Point CLion to the folder containing the top-level Makefile or to Makefile itself (in this case, click Open as Project on the next step).
Selectfrom the main menu.
Point CLion to the folder containing compile_commands.json or to the compile_commands.json itself (in this case, click Open as Project on the next step).
Selectfrom the main menu.
Point CLion to the folder containing build.gradle or to the build.gradle file itself (in this case, click Open as Project on the next step).
Clone a repository
Click Get from VCS on the Welcome screen or select Git (or your VCS) | Clone.
Enter the credentials to access the storage and provide the path to the sources.
Create a new CMake project
Select New Project on the Welcome screen.from the main menu or click
Set the type of your project: C or C++, an executable or a library.
Provide the root folder location and select the language standard.
CLion creates a new CMake project and fills in the top-level CMakeLists.txt:
The initial CMakeLists.txt file already contains several commands. Find their description and more information on working with CMake in our tutorial.
2. Take a look around
Find a detailed description of the new UI elements in New UI.
Find a detailed description of the Classic UI elements in User interface.
Any time you need to find an IDE action, press Control+Shift+A or go toand start typing the name of a command, setting, or even a UI element that you are looking for:
3. Customize your environment
Change the IDE appearance
To invoke it, clickor press Control+`:
To explore all the customizable options, go to the dedicated pages inControl+Alt+S.
Tune the editor
Pages under the Editor node of the dialog help you adjust the editor’s behavior, from the most general settings (like Drag'n'Drop enabling and scroll configuration) to highlighting colors and code style options.
Code styles are configurable for each language separately in the pages under the C/C++, you can set one of the predefined code styles or provide your own, and configure the desired naming convention including the header guard template:node. For
Adjust the keymap
In CLion, almost every action possible in the IDE is mapped to a keyboard shortcut. To view the default mapping, call.
You can customize the shortcuts in. Use one of the predefined keymaps (Visual Studio, Emacs, Eclipse, NetBeans, Xcode, and others) and tune it as required, or create your own keymap from scratch.
There are also plugins that extend the list of available keymaps. For example, VS Code Keymap or Vim emulation (which includes the Vim keymap). Find more useful plugins for the CLion editor in Valuable non-bundled plugins.
4. Code with assistance
Completion Control+Space in CLion works as you type and gives a list of all available completions. To filter this list and see only the suggestions that match the expected type, use Smart completion Control+Shift+Space:
Completion, along with other code insight features, is available for CMake code as well. See Coding assistance in CMakeLists.txt.
Even an empty class or a new C/C++ file contains boilerplate code, which CLion generates automatically. For example, when you add a new class, CLion creates a header with stub code and header guard already placed inside, and the corresponding source file that includes it.
One of the most useful code generation features is create from usage. It helps you focus on the ideas as they come up and takes care of the routine.
For example, when you call a function that is not yet implemented, there is no need to break the flow: press Alt+Enter to generate stub code that you can come back to later. Create from usage works for variables and classes as well:
To get the list of code generation options at any place in your code, press Alt+Insert to invoke the Generate menu:
These options can help you skip a lot of code writing. In addition to generating constructors/destructors, getters/setters, and various operators, you can quickly override and implement functions:
Live templates are the tool to generate entire code constructs. Find the list of ready-to-use templates in . To paste a template in your code, call or press Control+J, for example:
To quickly surround your code with loops and conditional statements like
#ifdef, call or press Control+Alt+T:
Intentions and quick-fixes
When you see a light bulb next to a symbol in your code, it means that CLion's code analysis has found a potential problem or a possible change to be made:
indicates an error and lets you choose a quick fix for it,
indicates that one or several intention actions are available.
Click the light bulb icon (or press Alt+Enter) and choose the most suitable action or quick-fix:
During on-the-fly code analysis, CLion highlights suspicious code and shows colored stripes in the right-hand gutter. You can hover over a stripe to view the problem description and click it to jump to the corresponding issue. The sign at the top of the gutter indicates the overall file status:
CLion detects not only compilation errors but also code inefficiencies like unused variables or dead code. Also, it integrates a customizable set of Clang-tidy checks.
To enable or disable inspections, configure their severity levels (whether an inspection should raise an error or just be shown as a warning) and set the scopes, go to.
You can also run inspections on demand for the whole project or a custom scope, and view the results in a separate window. For this, callor use Control+Alt+Shift+I for a particular inspection.
From the results tool window, you can batch-apply quick fixes for several issues at a time. Click Fix partially in the description tab:
Refactorings help improve your code without adding new functionality, making it cleaner and easier to read and maintain. Use the Refactor section of the main menu or call Refactor This... Control+Alt+Shift+T to get the list of refactorings available at the current location:
Rename Shift+F6 renames a symbol in all references;
Change Signature Control+F6 adds, removes, or reorders function parameters, changes the return type, or updates the function name (affecting all usages);
Pull Members Up/Down ( ) safely moves class members to the base or subclass.
5. Explore your code
To search for anything in CLion, be it an item in your codebase, action, or UI element, press Shift twice and start typing what you are looking for in the Search Everywhere dialog. Use the filter menu to narrow your search:
To locate the usage of any code symbol, call Find Usages (Alt+F7 or ). You can filter the results and jump back to the source code:
Navigate in the code structure
Switch between header and source file F10
Go to declaration/definition Control+BControl+Alt+B
Show file structure Alt+7
View type hierarchy Control+H
View call hierarchy Control+Alt+H
View import hierarchy Alt Shift H
For your code, CLion builds the hierarchies of types, call, imports, and functions. To view them, use the shortcuts given above or the commands in the menu. For example, type hierarchy helps you not only to navigate the code but also to discover what type relationships exist in the your codebase:
To explore the structure of the currently opened file, callor press Alt+7:
Also, use the left gutter icons to quickly jump to a declaration/definition or navigate through the class hierarchy ( / , / ).
View pop-up documentation
Quick Documentation popup (available on mousehover or via the Control+Q shortcut) helps you get more information on a symbol at caret without leaving the current context. Depending on the element you invoke it for, the popup shows:
function signature details,
code documentation (either regular or Doxygen comments),
inferred types for variables declared as
formatted macro expansions:
Besides, you can instantly view the definition of a symbol at caret. Press Control+Shift+I to invoke the Quick Definition popup:
6. Build and run
Run single file
If you have only one or two files to compile and run, there is no need for you to get into project models: your files can be compiled and run/debug without it.
In the editor, click the left gutter icon next to your program's entry point and select the action:
For each target in your project, CLion creates a run/debug configuration. It is a named setup which includes target, executable, arguments to pass to the program, and other options.
Run/Debug configurations are generated from templates, such as CMake Application, Google Test, Remote GDB Debug, and so on. The templates are customizable: when you edit a template parameter, you change the default settings of all configurations that will be created from this template later.
Run menu or the configuration switcher. Here you can manage the templates and add, delete, or edit your configurations.dialog is accessible from the
To launch your program, select the desired configuration and use commands from the Run menu or press Shift+F10. Alternatively, invoke the Run Anything dialog by pressing Ctrl twice and start typing the configuration name:
Build is included in many Run/Debug configuration templates as a default pre-launch step. However, you can also perform it separately by calling the desired action from the Build menu:
Notice the Recompile option that compiles a selected file without building the whole project.
Remote and embedded development
CLion integrates with the GDB backend on all platforms (on Windows, the bundled GDB is available only for MinGW) and LLDB on macOS/Linux. You can switch to a custom version of GDB on all platforms. Also, CLion provides an LLDB-based debugger for MSVC on Windows.
Currently, the versions of the bundled debuggers are the following:
LLDB v 15.0.5 for macOS/Linux and 9.0.0 for Windows (MSVC)
GDB v 13.1 for Windows
GDB v 13.1 for Linux
Custom GDB v 7.8.x-13.1
To start a debug session, select the desired configuration and press Shift+F9 or click . You can set breakpoints by clicking the gutter next to a code line. To follow through the execution process, use debugger's stepping actions:
In the Variables tab of the debugger tool window, you can explore the values and change them without interrupting your debug session. To evaluate an expression, press Alt+F8. CLion also shows the current variables' values right in the editor, and in case you enable hex view, it is shown inlined as well:
Useful debugger shortcuts
View breakpoint details/all breakpoints
Debug code at caret
8. Analyze at run-time
Some vulnerabilities and bugs can only be revealed during the program's execution: memory leaks, uninitialized accesses, concurrency issues, undefined behavior, and others.
Also, you can analyze your application performance using the built-in CPU Profiler and measure code coverage. For these tools, CLion provides visualized output and handy features like the option to import/export analysis results.
Settings for Valgrind, Sanitizers, and Profile are located under.
For more information, refer to the section about Dynamic code analysis.
Valgrind Memcheck in CLion works on Linux, macOS, and Windows via WSL. You need to install Valgrind, point CLion to the binary, set up the analysis flags, and then run the program using or by pressing .
Google Sanitizers are supported on Linux for certain versions of Clang and GCC. Take a look at our detailed guide on using Sanitizers in CLion.
CLion’s profiler, available on Linux and macOS, collects performance data for both user and kernel code of your application. The profiler collects performance metrics and visualizes them in flame charts and statistic views. To run it, call or use the button.
Code Coverage integration in CLion is based on llvm-cov/gcov tools and is available for CMake applications and tests. Coverage results show the percentage of files per folder and lines per file covered during a launch. To get coverage measurements, set the necessary compiler flags and call or click .
9. Add unit tests
CLion supports Google Test, Boost.Test, Catch(2), CTest, and Doctest testing frameworks with the built-in test runner and dedicated Run/Debug configurations. For CMake targets linked with gtest or gmock, CLion creates Google Test configurations automatically.
Running tests is similar to running a regular executable: CLion passes the specified test classes or methods to the test runner. Test runner shows the progress bar, output stream, and tree view of the running tests, and indicates their status and duration:
You can rerun particular tests, all of them, or only the failed ones , export test results and open previous results from the history.
Icons in the left gutter help you quickly run/debug tests and check the test status, success or failure :
10. Keep it under version control
CLion integrates with several version control systems: Git (or GitHub), Mercurial, Perforce, and Subversion. To manage the settings of a particular VCS, go to .
Use the VCS Operations Popup (Alt+` or ) to call version control commands. The list of actions in this popup includes both the currently enabled VCS and local history. For example:
No VCS Enabled
You can find all the available VCS commands in the VCS section of the main menu. Also, some basic commands are accessible from the toolbar:
In addition to full version control, you can go back and review changes step by step by browsing the local history. To view it for a file or folder, call . Here you can revert changes and create patches:
11. Learn more
We hope this brief overview of the CLion essentials will give you a quick start. To dig deeper, take a look at other articles and sections in the webhelp, for example: