CLion 2018.2 Help

Quick Tutorial on Configuring CLion on macOS

This tutorial will guide you through the process of installing, updating, and initial configuration of CLion on macOS.

Installation procedures

Before you start the CLion installation on macOS, make sure your machine meets the hardware requirements, and the version of your macOS is 10.9.4+.

Manual installation and patch updates

  1. Download the latest release or EAP version of CLion for macOS (earlier versions are available on the Previous CLion Releases page).
  2. Open the downloaded CLion-*.dmg package and drag CLion to the Applications folder.
  3. Open the Applications folder and launch the CLion installer.
  4. If the security warning appears, agree to open the application:
    cl macinstall warning
  5. When you install CLion manually, the update checking is performed automatically by default (every time the IDE is ready to update, you will see a message in the Status Bar). To configure the update process, go to Preferences | Appearance and Behaviour | System Settings | Updates and select the update channel:
    cl updatechannel choice
    Click Check now to perform the checking right away. In case there are available updates according to the chosen channel, you will see a dialog like the following:
    cl update prompt

Installation and update via Toolbox

Toolbox is a control panel that allows you to manage all JetBrains developer tools, including CLion, as well as your projects, from a single point of access. It enables you to maintain different versions of CLion, install updates and roll them back if needed. Toolbox remembers your JetBrains Account and uses it to automatically log in when you install and register new tools.

  1. Download Toolbox and launch the setup file.
  2. When the installation is complete, accept the JetBrains privacy policy and sign in to your JetBrains Account.
  3. Now you can choose which version of CLion to install:
    Toolbox App
  4. Toolbox shows the list of the installed versions:
    cl toolbox installed
  5. In the Settings dialog, configure the way of updating CLion:
    cl toolbox update
    Note that in case of using Toolbox, the update process cannot be configured from within the IDE. The Preferences | Appearance and Behaviour | System Settings | Updates dialog shows the following message:
    cl toolbox externalupdate

After the installation or upgrade, you will be prompted to import, inherit, or create new settings for the IDE.

Required tools

CLion needs to be provided with C and C++ compilers and the make utility. These tools may be pre-installed on your system (check in Preferences | Build, Execution, Deployment | Toolchains, the compiler and make detection should perform successfully).

If your system does not have working installations of compilers and make, the simplest solution is to install Xcode command line developer tools.

  1. Run the following command:
    xcode-select --install
  2. When prompted to install command line developer tools, click the Install button:
    cl xcodetools
    You can also choose to install the full package of Xcode, though it is not necessary for CLion.

With Xcode command line tools, you get the Clang compiler installed by default. To check the compiler presence and its version, run clang --version.

Command line tools may not update automatically along with the system or Xcode update. This may cause error messages like invalid active developer path during project loading in CLion. To fix this, run the same xcode-select --install command, and the tools will be updated accordingly.

Note that you can use multiple compilers for the needs of your project, see Switching Compilers.

Configure toolchains

Now you need to configure the toolchain to work with, which means choosing the CMake executable, the make and C/C++ compilers location, and the debugger. Navigate to Preferences | Build, Execution, Deployment | Toolchains and edit the default toolchain, or click icons toolbarDecorator mac add to add a new one.

CMake, make, and compilers

In the CMake field, specify the CMake binary that you want to use. You may stick to the bundled CMake, or use your custom CMake executable (see the minimum supported version in Software requirements).

The chosen CMake attempts to detect the compilers and make considering the packages installed on your system. If the detection succeeds, the fields Make, C Compiler, and C++ Compiler are filled automatically:

cl toolchain detectok

The detection of compilers and make fails if CMake cannot locate the appropriate tools (this may happen, for instance, if you installed them separately without the Xcode developer tools). In this case, you need to provide the actual paths manually.

Debugger

CLion for macOS comes with the bundled LLDB v 6.0 (the default debugger) and GDB v 8.0.1. You can also switch to a custom GDB (supported versions are 7.8.x-8.1.x). Select the debugger in Preferences | Build, Execution, Deployment | Toolchains:

cl selectdebugger mac

Issues are possible when working with both bundled or custom GDB on macOS. To improve the behavior, enable the cidr.debugger.gdb.workaround.macOS.startupWithShell option in Registry (select Help | Find Action from the main menu and type Registry):

cl gdbregisrty

Note that enabling this option is not equivalent to setting set startup-with-shell off in your .gdbinit script.

Further steps

Now that you have CLion installed and configured, you may find the following articles useful for further steps of the development:

Last modified: 18 September 2018