Skip to content
Zephyr IDE

Configuration

The following settings are available in VS Code settings (File > Preferences > Settings):

zephyr-ide.global_directory

  • Type: String or null
  • Default: null
  • Description: Manually specify a global directory for west workspace installation and Zephyr tools

This setting replaces the deprecated zephyr-ide.tools_directory. It controls the root location used for west workspace setup, Python virtual environments, and (by default) SDK toolchain installations. Useful for shared environments or when you need to install tools in a specific location.

zephyr-ide.tools_directory

  • Type: String or null
  • Default: null
  • Deprecated: Use zephyr-ide.global_directory instead. The extension automatically migrates this setting on startup.

zephyr-ide.toolchain_directory

  • Type: String or null
  • Default: null
  • Description: Manually specify the directory containing Zephyr SDK installations (e.g., containing zephyr-sdk-0.17.0, zephyr-sdk-0.17.3 subdirectories). If not specified, defaults to toolchains subdirectory within the tools directory.

This setting allows you to use a custom location for SDK installations. The directory should contain one or more Zephyr SDK installations with names like zephyr-sdk-0.17.0, zephyr-sdk-0.17.3, etc. The extension will automatically detect and use the latest version.

Example:

{
  "zephyr-ide.toolchain_directory": "/opt/zephyr-sdks"
}

With this configuration, the extension will look for SDKs in /opt/zephyr-sdks/zephyr-sdk-0.17.0, /opt/zephyr-sdks/zephyr-sdk-0.17.3, etc.

zephyr-ide.use_gui_config

  • Type: Boolean
  • Default: false
  • Description: Display GUI config instead of menu config in Project Tree View

When enabled, the extension will use the graphical Kconfig interface instead of the text-based menu config when configuring projects.

zephyr-ide.westNarrowUpdate

  • Type: Boolean
  • Default: false
  • Description: If true, uses ‘west update —narrow’. If false, uses ‘west update’ without —narrow.

The --narrow flag tells west to only clone the most recent commit history, which can save disk space and download time. This is useful for CI/CD environments or when you don’t need the full git history.

zephyr-ide.suppress-workspace-warning

  • Type: Boolean
  • Default: false
  • Description: If true, suppresses the warning about missing workspace environment variables (ZEPHYR_BASE, ZEPHYR_SDK_INSTALL_DIR).

Use this setting when working with externally managed environments to prevent the extension from showing warnings about missing workspace configuration.

zephyr-ide.venv-folder

  • Type: String or null
  • Default: null
  • Description: Manually specify a Python virtual environment folder path. If not specified, defaults to .venv in the workspace setup path.

This allows you to use a custom location for the Python virtual environment instead of the default .venv folder in your workspace.

Next Steps