GoLand 2020.3 Help

Advanced configuration

Besides the standard options available , GoLand enables you to perform low-level configuration of the underlying platform and the Java runtime.

JVM options

GoLand runs on the Java Virtual Machine (JVM), which has various options that control its performance. The default options used to run GoLand are specified in the following file:

<IDE_HOME>\bin\goland64.exe.vmoptions (for the default 64-bit JVM)

<IDE_HOME>\bin\goland.exe.vmoptions (for the optional 32-bit JVM)

GoLand.app/Contents/bin/goland.vmoptions

<IDE_HOME>/bin/goland64.vmoptions (for the default 64-bit JVM)

<IDE_HOME>/bin/goland.vmoptions (for the optional 32-bit JVM)

Configure JVM options

Do one of the following to create a copy of the default file with JVM options in the configuration directory that will override the original file:

  • On the Help menu, click Edit Custom VM Options.

  • If you do not have any project open, on the Welcome screen, click Configure and then Edit Custom VM Options.

  • If you cannot start GoLand, manually copy the default file with JVM options to the GoLand configuration directory.

If you do not have write access to the GoLand configuration directory, you can add the GOLAND_VM_OPTIONS environment variable to specify the location of the file with your preferred JVM options. This file will override both the original default file and the copy located in the GoLand configuration directory.

Common options

The default values of the JVM options should be optimal in most cases. The following are the most commonly modified ones:

OptionDescription
-Xmx Limits the maximum memory heap size that the JVM can allocate for running GoLand. Default value depends on the platform. If you are experiencing slowdowns, you may want to increase this value, for example, to set the value to 2048 megabytes, change this option to -Xmx2048m.
-Xms Specifies the initial memory allocated by the JVM for running GoLand. Default value depends on the platform. It is usually set to about half of the maximum allowed memory (-Xmx), for example, -Xms1024m.
-XX:NewRatio Specifies the ratio between the size of the young and old generation of the heap. In most cases, a ratio between 2 and 4 is recommended. This will set the size of the young generation to be 1/2 to 1/4 of the old generation correspondingly, which is good when you are often working on one project and only a few files at a time. However, if you are constantly opening new files and switching between several projects, you may need to increase the young generation. In this case, try setting -XX:NewRatio=1, which will make the young generation as large as the old generation, allowing objects to remain in the young generation for longer.

For more information about available JVM options, see the java reference for Windows or macOS/Linux.

Platform properties

GoLand enables you to customize various platform-specific properties, such as the path to user-installed plugins and the maximum supported file size. The default properties used to run GoLand are specified in the following file:

<IDE_HOME>\bin\idea.properties

GoLand.app/Contents/bin/idea.properties

<IDE_HOME>/bin/idea.properties

Configure platform properties:

Do one of the following to create an empty idea.properties file in the configuration directory that will override the values from the original file:

  • From the Help menu, select Edit Custom Properties.

  • If you do not have any project open, on the Welcome screen, click Configure and then select Edit Custom Properties.

  • If you cannot start GoLand, manually create an empty idea.properties file in the GoLand configuration directory.

If you do not have write access to the GoLand configuration directory, you can add the GOLAND_PROPERTIES environment variable to specify the location of the idea.properties file. The properties in this file will override the corresponding properties in both the original default file and the one located in the GoLand configuration directory.

Common properties

Users often change the following properties:

  • The default IDE directories may need to be moved, for example, if the user profile drive runs out of space or it is located on a slow disk, if the home directory is encrypted (slowing down the IDE) or located on a network drive, if you want to create a portable installation or exclude caches from home directory backups, and so on.

    PropertyPath to
    idea.config.pathConfiguration directory
    idea.system.pathSystem directory
    idea.plugins.pathPlugins directory
    idea.log.pathLogs directory

    Specify paths with forward slashes /, including Windows paths (for example, C:/idea/system).

    You can insert properties as variables. For example, use ${user.home} (standard Java system property) to specify paths relative to the user's home directory:

    idea.config.path=${user.home}/MyIdeaConfiguration
  • Limits that can affect performance:

    PropertyDescription
    idea.max.content.load.filesize Maximum size of files (in kilobytes) that GoLand is able to open. Working with large files can affect editor performance and increase memory consumption. The default value is 20000.
    idea.max.intellisense.filesize Maximum size of files (in kilobytes) for which GoLand provides coding assistance. Coding assistance for large files can affect editor performance and increase memory consumption. The default value is 2500.
    idea.cycle.buffer Maximum size of the console cyclic buffer (in kilobytes). If the console output size exceeds this value, the oldest lines are deleted. To disable the cyclic buffer, set idea.cycle.buffer.size=disabled.
    idea.max.vcs.loaded.size.kb Maximum size (in kilobytes) that GoLand loads for showing past file contents when comparing changes. The default value is 20480.

GoLand provides a number of other properties that define interaction with the environment (window managers, launchers, file system, and so on). Most of them act like hidden settings (in the sense that they are not evidently exposed), which you may need to enable or disable in certain cases. Change these properties only if advised by JetBrains Support.

Default IDE directories

By default, GoLand stores user-specific files (configuration, caches, plugins, logs, and so on) in the user's home directory. However, you can change the location for storing those files, if necessary.

Configuration directory

The GoLand configuration directory contains user-defined IDE settings, such as keymaps, color schemes, custom VM options, platform properties, and so on.

Syntax
%APPDATA%\JetBrains\<product><version>
Example
C:\Users\JohnS\AppData\Roaming\JetBrains\%ide_system_dir%2020.3
Syntax
~/Library/Application Support/JetBrains/<product><version>
Example
~/Library/Application Support/JetBrains/%ide_system_dir%2020.3
Syntax
~/.config/JetBrains/<product><version>
Example
~/.config/JetBrains/%ide_system_dir%2020.3

You can change the location of the GoLand configuration directory using the idea.config.path property.

To share your personal IDE settings, copy the files from the configuration directory to the corresponding folders on another GoLand installation. Make sure that GoLand is not running to avoid erasing the copied files when you shut down the IDE. Depending on which settings you modified, the GoLand configuration directory can contain the following subfolders:

DirectoryUser settings
codestylesCode style schemes
colors Customized editor color and font schemes
fileTemplatesUser-defined file templates which pertain to the entire GoLand workspace
filetypes User-defined file types
inspectionCode inspection profiles
keymapsCustomized keyboard shortcuts
optionsVarious options, for example, feature usage statistics and macros
scratchesScratch files and buffers
templates User-defined live templates
tools Configuration files for user-defined external tools
shelfShelved changes

System directory

The GoLand system directory contains caches and local history files.

Syntax
%LOCALAPPDATA%\JetBrains\<product><version>
Example
C:\Users\JohnS\AppData\Local\JetBrains\%ide_system_dir%2020.3
Syntax
~/Library/Caches/JetBrains/<product><version>
Example
~/Library/Caches/JetBrains/%ide_system_dir%2020.3
Syntax
~/.cache/JetBrains/<product><version>
Example
~/.cache/JetBrains/%ide_system_dir%2020.3

You can change the location of the GoLand system directory using the idea.system.path property.

Plugins directory

The GoLand plugins directory contains user-installed plugins.

Syntax
%APPDATA%\JetBrains\<product><version>\plugins
Example
C:\Users\JohnS\AppData\Roaming\JetBrains\%ide_system_dir%2020.3\plugins
Syntax
~/Library/Application Support/JetBrains/<product><version>/plugins
Example
~/Library/Application Support/JetBrains/%ide_system_dir%2020.3/plugins
Syntax
~/.local/share/JetBrains/<product><version>
Example
~/.local/share/JetBrains/%ide_system_dir%2020.3

You can change the location of the GoLand plugins directory using the idea.plugins.path property.

Logs directory

The GoLand logs directory contains product logs and thread dumps.

Syntax
%LOCALAPPDATA%\JetBrains\<product><version>\log
Example
C:\Users\JohnS\AppData\Local\JetBrains\%ide_system_dir%2020.3\log
Syntax
~/Library/Logs/JetBrains/<product><version>
Example
~/Library/Logs/JetBrains/%ide_system_dir%2020.3
Syntax
~/.cache/JetBrains/<product><version>/log
Example
~/.cache/JetBrains/%ide_system_dir%2020.3/log

You can change the location of the GoLand logs directory using the idea.log.path property.

Last modified: 28 July 2020