Skip to content

Commit be47583

Browse files
kevinwang5658github-actions[bot]
kevinwang5658
authored and
github-actions[bot]
committed
feat: Add intellij-products resource (auto-generated from issue #61)
1 parent 100199b commit be47583

35 files changed

Lines changed: 3700 additions & 0 deletions

File tree

‎docs/resources/(resources)/clion.mdx‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: clion
3+
description: A reference page for the clion resource
4+
---
5+
6+
The clion resource installs [JetBrains CLion](https://www.jetbrains.com/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`).
7+
8+
## Parameters
9+
10+
- **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.
11+
12+
- **importSettings** *(boolean, optional, default: `true`)* — Controls whether the `settingsZip` is imported during `create`. Set to `false` to skip the import even when `settingsZip` is specified. This is a setting parameter and is not tracked as state, so it only has effect when the resource is first applied.
13+
14+
- **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.
15+
16+
- **jvmMaxHeapSize** *(string, optional)* — Maximum JVM heap allocated to CLion, e.g. `"2048m"` for 2 GB or `"4096m"` for 4 GB. Written to `clion.vmoptions` in the IDE config directory as `-Xmx<value>`.
17+
18+
- **jvmMinHeapSize** *(string, optional)* — Initial JVM heap allocated to CLion, e.g. `"512m"`. Written to `clion.vmoptions` as `-Xms<value>`. Typically set to half the max heap size.
19+
20+
## Example usage
21+
22+
### Install CLion with plugins
23+
24+
```json title="codify.jsonc"
25+
[
26+
{
27+
"type": "clion",
28+
"plugins": [
29+
"com.github.copilot",
30+
"Docker"
31+
]
32+
}
33+
]
34+
```
35+
36+
### Install CLion, import previous settings, and increase heap
37+
38+
```json title="codify.jsonc"
39+
[
40+
{
41+
"type": "clion",
42+
"settingsZip": "/path/to/clion-settings.zip",
43+
"importSettings": true,
44+
"jvmMaxHeapSize": "4096m",
45+
"jvmMinHeapSize": "1024m",
46+
"plugins": [
47+
"com.github.copilot",
48+
"Docker"
49+
]
50+
}
51+
]
52+
```
53+
54+
## Notes
55+
56+
- On macOS a CLI launcher symlink is created at `/usr/local/bin/clion` during install so that `clion` is available in terminal sessions. It is removed on destroy.
57+
- Plugin IDs must be exact JetBrains Marketplace IDs. You can find them on the plugin's Marketplace page under *Additional Information → Plugin ID*.
58+
- The `settingsZip` import only runs during `create` (first apply), not on subsequent applies. If you need to re-import, destroy and re-apply the resource.
59+
- JVM options are written to `clion.vmoptions` in `~/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.
60+
- On Linux, Snap must be available. Codify will attempt to install `snapd` via the system package manager if it is not found.

‎docs/resources/(resources)/goland.mdx‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: goland
3+
description: A reference page for the goland resource
4+
---
5+
6+
The goland resource installs [JetBrains GoLand](https://www.jetbrains.com/go/), a Go IDE. On macOS it is installed via Homebrew Cask (`brew install --cask goland`); on Linux via Snap (`snap install goland --classic`).
7+
8+
## Parameters
9+
10+
- **settingsZip** *(string, optional)* — Absolute path to a GoLand settings ZIP file (exported via *File | Manage IDE Settings | Export Settings*) to import on first install. The archive is extracted directly into the GoLand config directory, so all exported settings (keymaps, code styles, inspections, etc.) are applied before GoLand is first launched.
11+
12+
- **importSettings** *(boolean, optional, default: `true`)* — Controls whether the `settingsZip` is imported during `create`. Set to `false` to skip the import even when `settingsZip` is specified. This is a setting parameter and is not tracked as state, so it only has effect when the resource is first applied.
13+
14+
- **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.
15+
16+
- **jvmMaxHeapSize** *(string, optional)* — Maximum JVM heap allocated to GoLand, e.g. `"2048m"` for 2 GB or `"4096m"` for 4 GB. Written to `goland.vmoptions` in the IDE config directory as `-Xmx<value>`.
17+
18+
- **jvmMinHeapSize** *(string, optional)* — Initial JVM heap allocated to GoLand, e.g. `"512m"`. Written to `goland.vmoptions` as `-Xms<value>`. Typically set to half the max heap size.
19+
20+
## Example usage
21+
22+
### Install GoLand with plugins
23+
24+
```json title="codify.jsonc"
25+
[
26+
{
27+
"type": "goland",
28+
"plugins": [
29+
"com.github.copilot",
30+
"Docker"
31+
]
32+
}
33+
]
34+
```
35+
36+
### Install GoLand, import previous settings, and increase heap
37+
38+
```json title="codify.jsonc"
39+
[
40+
{
41+
"type": "goland",
42+
"settingsZip": "/path/to/goland-settings.zip",
43+
"importSettings": true,
44+
"jvmMaxHeapSize": "4096m",
45+
"jvmMinHeapSize": "1024m",
46+
"plugins": [
47+
"com.github.copilot",
48+
"Docker"
49+
]
50+
}
51+
]
52+
```
53+
54+
## Notes
55+
56+
- On macOS a CLI launcher symlink is created at `/usr/local/bin/goland` during install so that `goland` is available in terminal sessions. It is removed on destroy.
57+
- Plugin IDs must be exact JetBrains Marketplace IDs. You can find them on the plugin's Marketplace page under *Additional Information → Plugin ID*.
58+
- The `settingsZip` import only runs during `create` (first apply), not on subsequent applies. If you need to re-import, destroy and re-apply the resource.
59+
- JVM options are written to `goland.vmoptions` in `~/Library/Application Support/JetBrains/GoLand<version>/` on macOS and `~/.config/JetBrains/GoLand<version>/` on Linux. If GoLand has never been launched, Codify creates this directory and file automatically.
60+
- On Linux, Snap must be available. Codify will attempt to install `snapd` via the system package manager if it is not found.

‎docs/resources/(resources)/intellij-idea.mdx‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: intellij-idea
3+
description: A reference page for the intellij-idea resource
4+
---
5+
6+
The intellij-idea resource installs [JetBrains IntelliJ IDEA](https://www.jetbrains.com/idea/), a general-purpose JVM/Java IDE. As of 2025.3, IntelliJ IDEA ships as a unified distribution that includes both the free Community tier and Ultimate features, which unlock within the same install via a subscription. On macOS it is installed via Homebrew Cask (`brew install --cask intellij-idea`); on Linux via Snap (`snap install intellij-idea-community --classic`).
7+
8+
## Parameters
9+
10+
- **settingsZip** *(string, optional)* — Absolute path to an IntelliJ IDEA settings ZIP file (exported via *File | Manage IDE Settings | Export Settings*) to import on first install. The archive is extracted directly into the IntelliJ IDEA config directory, so all exported settings (keymaps, code styles, inspections, etc.) are applied before IntelliJ IDEA is first launched.
11+
12+
- **importSettings** *(boolean, optional, default: `true`)* — Controls whether the `settingsZip` is imported during `create`. Set to `false` to skip the import even when `settingsZip` is specified. This is a setting parameter and is not tracked as state, so it only has effect when the resource is first applied.
13+
14+
- **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.
15+
16+
- **jvmMaxHeapSize** *(string, optional)* — Maximum JVM heap allocated to IntelliJ IDEA, e.g. `"2048m"` for 2 GB or `"4096m"` for 4 GB. Written to `idea.vmoptions` in the IDE config directory as `-Xmx<value>`.
17+
18+
- **jvmMinHeapSize** *(string, optional)* — Initial JVM heap allocated to IntelliJ IDEA, e.g. `"512m"`. Written to `idea.vmoptions` as `-Xms<value>`. Typically set to half the max heap size.
19+
20+
## Example usage
21+
22+
### Install IntelliJ IDEA with plugins
23+
24+
```json title="codify.jsonc"
25+
[
26+
{
27+
"type": "intellij-idea",
28+
"plugins": [
29+
"com.github.copilot",
30+
"Docker"
31+
]
32+
}
33+
]
34+
```
35+
36+
### Install IntelliJ IDEA, import previous settings, and increase heap
37+
38+
```json title="codify.jsonc"
39+
[
40+
{
41+
"type": "intellij-idea",
42+
"settingsZip": "/path/to/intellij-idea-settings.zip",
43+
"importSettings": true,
44+
"jvmMaxHeapSize": "4096m",
45+
"jvmMinHeapSize": "1024m",
46+
"plugins": [
47+
"com.github.copilot",
48+
"Docker"
49+
]
50+
}
51+
]
52+
```
53+
54+
## Notes
55+
56+
- On macOS a CLI launcher symlink is created at `/usr/local/bin/idea` during install so that `idea` is available in terminal sessions. It is removed on destroy.
57+
- Plugin IDs must be exact JetBrains Marketplace IDs. You can find them on the plugin's Marketplace page under *Additional Information → Plugin ID*.
58+
- The `settingsZip` import only runs during `create` (first apply), not on subsequent applies. If you need to re-import, destroy and re-apply the resource.
59+
- JVM options are written to `idea.vmoptions` in `~/Library/Application Support/JetBrains/IntelliJIdea<version>/` on macOS and `~/.config/JetBrains/IntelliJIdea<version>/` on Linux. If IntelliJ IDEA has never been launched, Codify creates this directory and file automatically.
60+
- On Linux, Snap must be available. Codify will attempt to install `snapd` via the system package manager if it is not found.
61+
- IntelliJ IDEA is the unified distribution covering both the free Community tier and the Ultimate edition; Ultimate features are unlocked within the same install via an active subscription.

‎docs/resources/(resources)/phpstorm.mdx‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: phpstorm
3+
description: A reference page for the phpstorm resource
4+
---
5+
6+
The phpstorm resource installs [JetBrains PhpStorm](https://www.jetbrains.com/phpstorm/), a PHP IDE. On macOS it is installed via Homebrew Cask (`brew install --cask phpstorm`); on Linux via Snap (`snap install phpstorm --classic`).
7+
8+
## Parameters
9+
10+
- **settingsZip** *(string, optional)* — Absolute path to a PhpStorm settings ZIP file (exported via *File | Manage IDE Settings | Export Settings*) to import on first install. The archive is extracted directly into the PhpStorm config directory, so all exported settings (keymaps, code styles, inspections, etc.) are applied before PhpStorm is first launched.
11+
12+
- **importSettings** *(boolean, optional, default: `true`)* — Controls whether the `settingsZip` is imported during `create`. Set to `false` to skip the import even when `settingsZip` is specified. This is a setting parameter and is not tracked as state, so it only has effect when the resource is first applied.
13+
14+
- **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.
15+
16+
- **jvmMaxHeapSize** *(string, optional)* — Maximum JVM heap allocated to PhpStorm, e.g. `"2048m"` for 2 GB or `"4096m"` for 4 GB. Written to `phpstorm.vmoptions` in the IDE config directory as `-Xmx<value>`.
17+
18+
- **jvmMinHeapSize** *(string, optional)* — Initial JVM heap allocated to PhpStorm, e.g. `"512m"`. Written to `phpstorm.vmoptions` as `-Xms<value>`. Typically set to half the max heap size.
19+
20+
## Example usage
21+
22+
### Install PhpStorm with plugins
23+
24+
```json title="codify.jsonc"
25+
[
26+
{
27+
"type": "phpstorm",
28+
"plugins": [
29+
"com.github.copilot",
30+
"Docker"
31+
]
32+
}
33+
]
34+
```
35+
36+
### Install PhpStorm, import previous settings, and increase heap
37+
38+
```json title="codify.jsonc"
39+
[
40+
{
41+
"type": "phpstorm",
42+
"settingsZip": "/path/to/phpstorm-settings.zip",
43+
"importSettings": true,
44+
"jvmMaxHeapSize": "4096m",
45+
"jvmMinHeapSize": "1024m",
46+
"plugins": [
47+
"com.github.copilot",
48+
"Docker"
49+
]
50+
}
51+
]
52+
```
53+
54+
## Notes
55+
56+
- On macOS a CLI launcher symlink is created at `/usr/local/bin/phpstorm` during install so that `phpstorm` is available in terminal sessions. It is removed on destroy.
57+
- Plugin IDs must be exact JetBrains Marketplace IDs. You can find them on the plugin's Marketplace page under *Additional Information → Plugin ID*.
58+
- The `settingsZip` import only runs during `create` (first apply), not on subsequent applies. If you need to re-import, destroy and re-apply the resource.
59+
- JVM options are written to `phpstorm.vmoptions` in `~/Library/Application Support/JetBrains/PhpStorm<version>/` on macOS and `~/.config/JetBrains/PhpStorm<version>/` on Linux. If PhpStorm has never been launched, Codify creates this directory and file automatically.
60+
- On Linux, Snap must be available. Codify will attempt to install `snapd` via the system package manager if it is not found.

‎docs/resources/(resources)/pycharm.mdx‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: pycharm
3+
description: A reference page for the pycharm resource
4+
---
5+
6+
The pycharm resource installs [JetBrains PyCharm](https://www.jetbrains.com/pycharm/), a Python IDE. On macOS it is installed via Homebrew Cask (`brew install --cask pycharm`); on Linux via Snap (`snap install pycharm-community --classic`).
7+
8+
## Parameters
9+
10+
- **settingsZip** *(string, optional)* — Absolute path to a PyCharm settings ZIP file (exported via *File | Manage IDE Settings | Export Settings*) to import on first install. The archive is extracted directly into the PyCharm config directory, so all exported settings (keymaps, code styles, inspections, etc.) are applied before PyCharm is first launched.
11+
12+
- **importSettings** *(boolean, optional, default: `true`)* — Controls whether the `settingsZip` is imported during `create`. Set to `false` to skip the import even when `settingsZip` is specified. This is a setting parameter and is not tracked as state, so it only has effect when the resource is first applied.
13+
14+
- **plugins** *(string[], optional)* — JetBrains Marketplace plugin IDs to install (e.g. `"intellij.jupyter"`, `"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.
15+
16+
- **jvmMaxHeapSize** *(string, optional)* — Maximum JVM heap allocated to PyCharm, e.g. `"2048m"` for 2 GB or `"4096m"` for 4 GB. Written to `pycharm.vmoptions` in the IDE config directory as `-Xmx<value>`.
17+
18+
- **jvmMinHeapSize** *(string, optional)* — Initial JVM heap allocated to PyCharm, e.g. `"512m"`. Written to `pycharm.vmoptions` as `-Xms<value>`. Typically set to half the max heap size.
19+
20+
## Example usage
21+
22+
### Install PyCharm with plugins
23+
24+
```json title="codify.jsonc"
25+
[
26+
{
27+
"type": "pycharm",
28+
"plugins": [
29+
"intellij.jupyter",
30+
"Docker"
31+
]
32+
}
33+
]
34+
```
35+
36+
### Install PyCharm, import previous settings, and increase heap
37+
38+
```json title="codify.jsonc"
39+
[
40+
{
41+
"type": "pycharm",
42+
"settingsZip": "/path/to/pycharm-settings.zip",
43+
"importSettings": true,
44+
"jvmMaxHeapSize": "4096m",
45+
"jvmMinHeapSize": "1024m",
46+
"plugins": [
47+
"intellij.jupyter",
48+
"Docker"
49+
]
50+
}
51+
]
52+
```
53+
54+
## Notes
55+
56+
- On macOS a CLI launcher symlink is created at `/usr/local/bin/pycharm` during install so that `pycharm` is available in terminal sessions. It is removed on destroy.
57+
- Plugin IDs must be exact JetBrains Marketplace IDs. You can find them on the plugin's Marketplace page under *Additional Information → Plugin ID*.
58+
- The `settingsZip` import only runs during `create` (first apply), not on subsequent applies. If you need to re-import, destroy and re-apply the resource.
59+
- JVM options are written to `pycharm.vmoptions` in `~/Library/Application Support/JetBrains/PyCharm<version>/` on macOS and `~/.config/JetBrains/PyCharm<version>/` on Linux. If PyCharm has never been launched, Codify creates this directory and file automatically.
60+
- On Linux, Snap must be available. Codify will attempt to install `snapd` via the system package manager if it is not found.

‎docs/resources/(resources)/rider.mdx‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: rider
3+
description: A reference page for the rider resource
4+
---
5+
6+
The rider resource installs [JetBrains Rider](https://www.jetbrains.com/rider/), JetBrains' .NET/C# IDE, free for non-commercial use. On macOS it is installed via Homebrew Cask (`brew install --cask rider`); on Linux via Snap (`snap install rider --classic`).
7+
8+
## Parameters
9+
10+
- **settingsZip** *(string, optional)* — Absolute path to a Rider settings ZIP file (exported via *File | Manage IDE Settings | Export Settings*) to import on first install. The archive is extracted directly into the Rider config directory, so all exported settings (keymaps, code styles, inspections, etc.) are applied before Rider is first launched.
11+
12+
- **importSettings** *(boolean, optional, default: `true`)* — Controls whether the `settingsZip` is imported during `create`. Set to `false` to skip the import even when `settingsZip` is specified. This is a setting parameter and is not tracked as state, so it only has effect when the resource is first applied.
13+
14+
- **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.
15+
16+
- **jvmMaxHeapSize** *(string, optional)* — Maximum JVM heap allocated to Rider, e.g. `"2048m"` for 2 GB or `"4096m"` for 4 GB. Written to `rider.vmoptions` in the IDE config directory as `-Xmx<value>`.
17+
18+
- **jvmMinHeapSize** *(string, optional)* — Initial JVM heap allocated to Rider, e.g. `"512m"`. Written to `rider.vmoptions` as `-Xms<value>`. Typically set to half the max heap size.
19+
20+
## Example usage
21+
22+
### Install Rider with plugins
23+
24+
```json title="codify.jsonc"
25+
[
26+
{
27+
"type": "rider",
28+
"plugins": [
29+
"com.github.copilot",
30+
"Docker"
31+
]
32+
}
33+
]
34+
```
35+
36+
### Install Rider, import previous settings, and increase heap
37+
38+
```json title="codify.jsonc"
39+
[
40+
{
41+
"type": "rider",
42+
"settingsZip": "/path/to/rider-settings.zip",
43+
"importSettings": true,
44+
"jvmMaxHeapSize": "4096m",
45+
"jvmMinHeapSize": "1024m",
46+
"plugins": [
47+
"com.github.copilot",
48+
"Docker"
49+
]
50+
}
51+
]
52+
```
53+
54+
## Notes
55+
56+
- On macOS a CLI launcher symlink is created at `/usr/local/bin/rider` during install so that `rider` is available in terminal sessions. It is removed on destroy.
57+
- Plugin IDs must be exact JetBrains Marketplace IDs. You can find them on the plugin's Marketplace page under *Additional Information → Plugin ID*.
58+
- The `settingsZip` import only runs during `create` (first apply), not on subsequent applies. If you need to re-import, destroy and re-apply the resource.
59+
- JVM options are written to `rider.vmoptions` in `~/Library/Application Support/JetBrains/Rider<version>/` on macOS and `~/.config/JetBrains/Rider<version>/` on Linux. If Rider has never been launched, Codify creates this directory and file automatically.
60+
- On Linux, Snap must be available. Codify will attempt to install `snapd` via the system package manager if it is not found.

0 commit comments

Comments
 (0)