Open and create projects

Open a project

To open an existing CMake project in CLion, do one of the following:

• 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 choose Open as Project.

• Select File | Open and locate the CMakeCache.txt file, then choose Open as Project.

Create a new project

1. If no project is currently opened in CLion, click New Project on the Welcome screen. Otherwise, select File | New Project on the main menu.

2. In the New Project dialog that opens, select the target type of your project (executable or library), and the language to be used (pure C or C++). CLion will generate the top-level CMakeLists.txt file based on the provided settings.

Create a CMake project from sources

To work with non-CMake sources in CLion, you can convert them into a CMake project structure.

1. On the main menu, choose File | Open and select the project root folder.

2. Open a source file in the editor.

3. If there is no top-level CMakeLists.txt file, CLion will suggest creating it:

   

   note

   The Create CMakeLists.txt action appears only when there is no CMakeLists.txt under the project root, disregarding the subfolders' CMakeLists.txt files.

   If there is a CMakeLists.txt file under the root, the only available action will be Select CMakeLists.txt.

4. In the Create CMakeLists.txt dialog, specify the following:

   • Select project files- select the files to be imported as project files. Use the subdirectories checkboxes to import their entire contents or clear the checkboxes to import the contents selectively.

   • User Include Directories- select the directories to be included in the project and specified in the CMake include_directories command. CLion includes a directory automatically when it contains at least one header file, if it is named include, or when it has subdirectories that contain header files only.

     Note that directories not selected in the Select Project Files pane are not presented in the User Include Directories list - select them first, and then the available include directories will appear in the list.

   

Work with a monorepo

Monorepos are repositories that combine multiple projects, usually without a top-level CMake script. Instructions below describe how to work with a monorepo in CLion using LLVM Project as an example.

1. Call File | Open and point CLion to CMakeLists.txt in the required subdirectory. For the case of LLVM, select llvm-project/llvm/CMakeLists.txt.

   In the dialog that opens, click Open as Project.

2. Go to Settings/Preferences | Build, Execution, Deployment | CMake and use the CMake options field to add the sub-projects that you want to build additionally.

   For example, to add clang and clang-tools-extra, specify -DLLVM_ENABLE_PROJECTS=“clang;clang-tools-extra”:

   

   Project reload should perform successfully at this point.

3. To be able to view the entire repository in the Project tree, change the project root: call Tools | CMake | Change Project Root from the main menu and select the top-level repository folder, llvm-project.

4. We also recommend that you build the project. This way, resolve will work on the entire codebase, including the parts generated at build time.