clion
A reference page for the clion resource
The clion resource installs JetBrains CLion, a C/C++ IDE. On macOS it is installed via Homebrew Cask (brew install --cask clion); on Linux via Snap (snap install clion --classic).
Parameters
-
settingsZip (string, optional) — Absolute path to a CLion settings ZIP file (exported via File | Manage IDE Settings | Export Settings) to import on first install. The archive is extracted directly into the CLion config directory, so all exported settings (keymaps, code styles, inspections, etc.) are applied before CLion is first launched.
-
importSettings (boolean, optional, default:
true) — Controls whether thesettingsZipis imported duringcreate. Set tofalseto skip the import even whensettingsZipis specified. This is a setting parameter and is not tracked as state, so it only has effect when the resource is first applied. -
plugins (string[], optional) — JetBrains Marketplace plugin IDs to install (e.g.
"com.github.copilot","Docker"). Plugin IDs can be found on the plugin's page in the Marketplace under Additional Information. Plugins are managed statefully: Codify adds missing plugins and removes plugins no longer in the list. -
jvmMaxHeapSize (string, optional) — Maximum JVM heap allocated to CLion, e.g.
"2048m"for 2 GB or"4096m"for 4 GB. Written toclion.vmoptionsin the IDE config directory as-Xmx<value>. -
jvmMinHeapSize (string, optional) — Initial JVM heap allocated to CLion, e.g.
"512m". Written toclion.vmoptionsas-Xms<value>. Typically set to half the max heap size.
Example usage
Install CLion with plugins
[
{
"type": "clion",
"plugins": [
"com.github.copilot",
"Docker"
]
}
]Install CLion, import previous settings, and increase heap
[
{
"type": "clion",
"settingsZip": "/path/to/clion-settings.zip",
"importSettings": true,
"jvmMaxHeapSize": "4096m",
"jvmMinHeapSize": "1024m",
"plugins": [
"com.github.copilot",
"Docker"
]
}
]Notes
- On macOS a CLI launcher symlink is created at
/usr/local/bin/clionduring install so thatclionis available in terminal sessions. It is removed on destroy. - Plugin IDs must be exact JetBrains Marketplace IDs. You can find them on the plugin's Marketplace page under Additional Information → Plugin ID.
- The
settingsZipimport only runs duringcreate(first apply), not on subsequent applies. If you need to re-import, destroy and re-apply the resource. - JVM options are written to
clion.vmoptionsin~/Library/Application Support/JetBrains/CLion<version>/on macOS and~/.config/JetBrains/CLion<version>/on Linux. If CLion has never been launched, Codify creates this directory and file automatically. - On Linux, Snap must be available. Codify will attempt to install
snapdvia the system package manager if it is not found.