Skip to content

Settings and commands

To view the extension's command list, open the Command Palette Ctrl+Shift+P and type nRF Connect.

For a full overview of settings and commands, click the Extensions View from the Activity Bar > nRF Connect. Then choose the Feature Contributions tab.

nRF Connect commands in Feature Contributions

Additional settings information

The section provides more details on certain settings used by the extension.

nrf-connect.activeAppFollowActiveEditor

nrf-connect.activeAppFollowActiveEditor is the configuration setting that controls whether the extension will automatically switch to the application (and build configuration, if applicable) that the open file belongs to. This is the default behavior. When this setting is disabled, the active application will never change automatically.

nrf-connect.topdir

nrf-connect.topdir points to the west workspace path. This setting is relevant only for building freestanding applications. It is the final fallback to the ZEPHYR_BASE environment variable.

The nrf-connect.topdir setting is automatically set to the ${nrf-connect.sdk:VER} variable when a released version of the nRF Connect SDK is chosen in Quick Setup, the New Application wizard, or through the nRF Connect: Select nRF Connect SDK command. The variable is not used when the latest version of the nRF Connect SDK (the main branch denoted by x.y.99 version) is selected.

nrf-connect.toolchain.path

nrf-connect.toolchain.path is the path of the toolchain installed by the Toolchain Manager and overrides {nrf-connect.topdir}/toolchain. If neither are set, the toolchain will be expected to be located on PATH.

The nrf-connect.toolchain.path setting are automatically set to the ${nrf-connect.toolchain:VER} variable when a released version of the nRF Connect SDK toolchain is chosen in Quick Setup, the New Application wizard, or through the nRF Connect: Select nRF Connect SDK Toolchain command. The variable is not used when the toolchain path is expected to be present on the system path (PATH).

nrf-connect.west.env

nrf-connect.west.env is the configuration setting containing an object that will replace the west environment, as well as the special key $base. $base must either be "process", "terminal" or null, and will determine the initial environment. By default, $base is "terminal", which makes the extension pick up the platform-specific terminal environment. All other fields in this object will be added as environment variables, overriding any corresponding variables in the base environment.

{
  "$base": "process",
  "CUSTOM_ENV_VAR": "custom value",
  "OTHER_ENV_VAR": "another value",
}
Back to top