CLion Remote Toolchain and Remote Host Environment Variable Synchronization

Question

CLion allows developers to decouple the IDE from the build environment using Remote Toolchains via SSH. This setup synchronizes source code to a remote host and executes CMake commands using the remote system's compiler and debugger.

A discrepancy exists between the environment variables available in the remote shell and those recognized by the CLion CMake profile during the project load phase. While variables defined in the remote user's .bashrc or .zshrc are present during manual terminal execution, they may not be automatically inherited by the IDE's remote build process.

When relying on remote environment variables to locate third-party libraries or toolchain paths, it is unclear if CLion provides a mechanism to automatically sync the remote shell environment into the CMake profile without manual duplication in the IDE settings.

Does CLion support automatic inheritance of remote shell environment variables for CMake profiles?
  What is the recommended method to ensure remote-only environment variables are consistently applied across different remote toolchain configurations?

Tasadduq Burney · Answer

Answer
CLion does not automatically inherit the environment of an interactive remote shell into its CMake profiles. The IDE starts CMake over SSH in a non‑interactive session, so variables that are only set in .bashrc, .zshrc, or other interactive‑rc files are not present during the project‑load phase.
Why the variables disappear
Both Bash and Zsh guard their rc files against non‑interactive shells. In Bash the file usually contains a return or exit after a test like [[ $- != *i* ]] && return. Zsh only reads .zshrc for interactive shells and sources .zshenv for all shells. When CLion connects via SSH, the session is non‑interactive, so those rc files are skipped.
Recommended approach

Create a single script on the remote host, e.g. ~/cmake_env.sh, that exports all variables your builds need.
Source that script from the interactive rc file (e.g. add source ~/cmake_env.sh before the non‑interactive guard in .bashrc or in .zshenv for Zsh).
In CLion open Settings ► Build, Execution, Deployment ► CMake, select the remote profile, and in the Environment field either:

enter the script name if the IDE offers a “Load environment from script” option, or
use a command such as bash -c "source ~/cmake_env.sh && cmake ." as the custom CMake command.

After changing the script, reload the CMake profile (or invalidate the cache) and verify that the variables appear in the CMake output. Add message(STATUS "MY_VAR=$ENV{MY_VAR}") to CMakeLists.txt to see the value.

Alternative: explicit paths
If you prefer not to rely on shell variables, set compiler, debugger, and library paths directly in the remote toolchain settings or pass them as CMake options (-DCMAKE_PREFIX_PATH, -DCMAKE_TOOLCHAIN_FILE). This removes the dependency on the remote PATH and works the same for all toolchains.
Missing detail to check
Does your CLion version expose an “Environment script” field for remote CMake profiles? The UI for this feature changed after 2024.1, so confirm it is present before relying on the script‑loading shortcut.

CLion Remote Toolchain and Remote Host Environment Variable Synchronization

1 answer

Answer

Why the variables disappear

Recommended approach

Alternative: explicit paths

Missing detail to check

Your perspective belongs here.

0 question comments