Skip to content

How to work with nRF Kconfig GUI

The nRF Connect for VS Code extension allows you to view and customize your application's configuration with the nRF Kconfig GUI, a graphical representation of the Kconfig tree structure. The GUI displays a list of the Kconfig options used in your project files (such as prj.conf) and allows you to view and manage your Kconfig options.

This page provides information about the most common ways you can interact with the GUI. For a detailed description of all the interface options, see the Kconfig GUI page in the UI and reference section.

How to access the nRF Kconfig GUI

To open the nRF Kconfig GUI, click the Kconfig button from the Actions View.

Kconfig button in the Actions View

This opens the main screen of the Kconfig GUI.

Kconfig GUI main screen

Alternatively, you can run nRF Connect: Kconfig from the Command Palette to access the GUI.

How to customize the Kconfig options

Kconfig is organized in a hierarchical structure where child options are nested under parent options. In some cases, the parent option must be enabled first before the child option is visible.

Click the checkbox next to the option name to enable or disable the option (tick or untick the checkbox, respectively).

Enable Kconfig child options

How to save Kconfig changes

After customizing the Kconfig options, you must save the configuration file in the Kconfig GUI using one of dedicated options. This is different from the Devicetree Visual Editor, which propagates the changes to devicetree files in real time and where you can use the standard saving action either in the editor or in the file.

There are several ways to save your Kconfig option changes: Apply, Save to file, and Save (minimal). See the button tooltips for more information.

How to review and revert changes

The Changes tab lets you review which changes you have made to the Kconfig options. These are the changes to Kconfig options between project configuration files (prj_<file-name>.conf and Kconfig fragments) used for the current build configuration and the build configuration's .config file.

To see details about a particular option, click the tooltip icon.
The Kconfig option details appear in the adjacent information area.

To review or revert a changed option, click the Jump to Item button.
You will be redirected to the option within the Kconfig tree in the nRF Kconfig View.

View Kconfig changes