Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,25 @@
"editor.formatOnSave": true,
"git.enabled": false,
"terminal.integrated.defaultProfile.windows": "PowerShell",
"C_Cpp.default.compileCommands": "${workspaceFolder}\\.vscode\\compile_commands.json"
"C_Cpp.default.compileCommands": "${workspaceFolder}\\.vscode\\compile_commands.json",
"workbench.colorCustomizations": {
"activityBar.activeBackground": "#e9e5e0",
"activityBar.background": "#e9e5e0",
"activityBar.foreground": "#15202b",
"activityBar.inactiveForeground": "#15202b99",
"activityBarBadge.background": "#7da292",
"activityBarBadge.foreground": "#15202b",
"commandCenter.border": "#15202b99",
"sash.hoverBorder": "#e9e5e0",
"statusBar.background": "#d3ccc3",
"statusBar.foreground": "#15202b",
"statusBarItem.hoverBackground": "#bdb3a6",
"statusBarItem.remoteBackground": "#d3ccc3",
"statusBarItem.remoteForeground": "#15202b",
"titleBar.activeBackground": "#d3ccc3",
"titleBar.activeForeground": "#15202b",
"titleBar.inactiveBackground": "#d3ccc399",
"titleBar.inactiveForeground": "#15202b99"
},
"peacock.color": "#d3ccc3"
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ IDE for Zephyr automatically detects and works with externally managed Zephyr en
- Automatic detection via `ZEPHYR_BASE` environment variable
- No setup required when using Docker, DevContainers, or pre-configured environments
- Full support for build, flash, and debug operations
- Configurable warning suppression via `zephyr-ide.suppress-workspace-warning`
- Configurable warning suppression via `zephyr-ide.suppressWorkspaceWarning`

Ideal for Docker/container workflows, CI/CD pipelines, shared development environments, and pre-installed Zephyr setups.

Expand Down
22 changes: 11 additions & 11 deletions docs/MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Option 1: Click "Don't Show Again" when the warning appears
Option 2: Manually add to `.vscode/settings.json`:
```json
{
"zephyr-ide.suppress-workspace-warning": true
"zephyr-ide.suppressWorkspaceWarning": true
}
```

Expand Down Expand Up @@ -277,7 +277,7 @@ You can also use a code-workspace.json file to help manage projects across diffe
You can have a look at this [sample directory](https://github.com/mylonics/zephyr-ide-sample-project) to also help with getting started with sharing projects.

## Advanced Features
The Zephyr Menu Config or GUI Config may be run from the active project panel. In the project config panel, by default, a Menu Config option is available. This can be changed to GUI Config by adding `"zephyr-ide.use_gui_config": true` to settings.json. Each debug target may be bound to a custom launch configuration (by default they use "Zephyr IDE: Debug" and "Zephyr IDE: Attach").
The Zephyr Menu Config or GUI Config may be run from the active project panel. In the project config panel, by default, a Menu Config option is available. This can be changed to GUI Config by adding `"zephyr-ide.useGuiConfig": true` to settings.json. Each debug target may be bound to a custom launch configuration (by default they use "Zephyr IDE: Debug" and "Zephyr IDE: Attach").

![Demonstrating MenuConfig](https://raw.githubusercontent.com/mylonics/zephyr-ide/main/docs/media/demonstrating_menu_config_debug_binding.gif)

Expand Down Expand Up @@ -411,37 +411,37 @@ IDE for Zephyr provides the following commands accessible via the command palett

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

### `zephyr-ide.global_directory`
### `zephyr-ide.globalDirectory`
- **Type**: String or null
- **Default**: null
- **Description**: Manually specify a global directory for west workspace installation and Zephyr tools. Replaces the deprecated `zephyr-ide.tools_directory`.

### `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.
- **Deprecated**: Use `zephyr-ide.globalDirectory` instead. The extension automatically migrates this setting on startup.

### `zephyr-ide.toolchain_directory`
### `zephyr-ide.toolchainDirectory`
- **Type**: String or null
- **Default**: null
- **Description**: Manually specify the directory containing Zephyr SDK installations. If not specified, defaults to the `toolchains` subdirectory within the global directory.

### `zephyr-ide.use_gui_config`
### `zephyr-ide.useGuiConfig`
- **Type**: Boolean
- **Default**: false
- **Description**: Display GUI config instead of menu config in Project Tree View
- **Description**: Use GUI configuration editor instead of terminal-based menuconfig in the Project Tree View.

### `zephyr-ide.westNarrowUpdate`
- **Type**: Boolean
- **Default**: false
- **Description**: If true, uses 'west update --narrow'. If false, uses 'west update' without --narrow.
- **Description**: Use 'west update --narrow' to reduce disk usage and download time by fetching only required Git history.

### `zephyr-ide.suppress-workspace-warning`
### `zephyr-ide.suppressWorkspaceWarning`
- **Type**: Boolean
- **Default**: false
- **Description**: If true, suppresses the warning about missing workspace environment variables (ZEPHYR_BASE, ZEPHYR_SDK_INSTALL_DIR).
- **Description**: Hide the notification about missing ZEPHYR_BASE and ZEPHYR_SDK_INSTALL_DIR environment variables. Enable this if you manage these variables externally.

### `zephyr-ide.venv-folder`
### `zephyr-ide.venvFolder`
- **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.
Expand Down
Binary file added docs/media/project-page-ui-build-two-column.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/project-page-ui-dtc-cmake.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/project-page-ui-dtc-west.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/project-page-ui-kconfig-west.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If you prefer to work without setting `ZEPHYR_BASE` (e.g., using west commands d
**Option 2**: Manually add to `.vscode/settings.json`:
```json
{
"zephyr-ide.suppress-workspace-warning": true
"zephyr-ide.suppressWorkspaceWarning": true
}
```

Expand Down
20 changes: 10 additions & 10 deletions docs/src/content/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: All IDE for Zephyr VS Code settings — global directory, toolchain

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

## `zephyr-ide.global_directory`
## `zephyr-ide.globalDirectory`

- **Type**: String or null
- **Default**: null
Expand All @@ -17,9 +17,9 @@ This setting replaces the deprecated `zephyr-ide.tools_directory`. It controls t

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

## `zephyr-ide.toolchain_directory`
## `zephyr-ide.toolchainDirectory`

- **Type**: String or null
- **Default**: null
Expand All @@ -30,37 +30,37 @@ This setting allows you to use a custom location for SDK installations. The dire
**Example:**
```json
{
"zephyr-ide.toolchain_directory": "/opt/zephyr-sdks"
"zephyr-ide.toolchainDirectory": "/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`
## `zephyr-ide.useGuiConfig`

- **Type**: Boolean
- **Default**: false
- **Description**: Display GUI config instead of menu config in Project Tree View
- **Description**: Use GUI configuration editor instead of terminal-based menuconfig in the 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.
- **Description**: Use 'west update --narrow' to reduce disk usage and download time by fetching only required Git history.

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`
## `zephyr-ide.suppressWorkspaceWarning`

- **Type**: Boolean
- **Default**: false
- **Description**: If true, suppresses the warning about missing workspace environment variables (ZEPHYR_BASE, ZEPHYR_SDK_INSTALL_DIR).
- **Description**: Hide the notification about missing ZEPHYR_BASE and ZEPHYR_SDK_INSTALL_DIR environment variables. Enable this if you manage these variables externally.

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

## `zephyr-ide.venv-folder`
## `zephyr-ide.venvFolder`

- **Type**: String or null
- **Default**: null
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/user-guide/other-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Use MenuConfig, GuiConfig, custom west/CMake build arguments, ROM/R

## Menu Config and GUI Config

The Zephyr Menu Config or GUI Config may be run from the active project panel. In the project config panel, by default, a Menu Config option is available. This can be changed to GUI Config by adding `"zephyr-ide.use_gui_config": true` to settings.json.
The Zephyr Menu Config or GUI Config may be run from the active project panel. In the project config panel, by default, a Menu Config option is available. This can be changed to GUI Config by adding `"zephyr-ide.useGuiConfig": true` to settings.json.

Each debug target may be bound to a custom launch configuration (by default they use "Zephyr IDE: Debug" and "Zephyr IDE: Attach").

Expand Down
Loading
Loading