https://github.com/ksachdeva/zephyr-kconfig
Various tools/helpers/cli to assist with ZephyrOS's KConfig
https://github.com/ksachdeva/zephyr-kconfig
Last synced: about 2 months ago
JSON representation
Various tools/helpers/cli to assist with ZephyrOS's KConfig
- Host: GitHub
- URL: https://github.com/ksachdeva/zephyr-kconfig
- Owner: ksachdeva
- License: apache-2.0
- Created: 2026-01-15T19:21:14.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-03-05T00:20:05.000Z (5 months ago)
- Last Synced: 2026-03-05T06:28:03.205Z (5 months ago)
- Language: Python
- Size: 272 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zephyr KConfig
Various tools/helpers/cli to assist with Zephyr's KConfig
## Run / Install
### Run via `uvx`
```bash
# always fetches the latest version
uvx --from zepyhr-kconfig --help
```
### Install as a tool (via `uv`)
```bash
# installs the current version
uv tool install zephyr-kconfig
```
Above also install `zkc` cli (also accessible via `zephyr-kconfig` if you have conflict with `zkc`)
```bash
# examples - (zkc is an alias to zephyr-kconfig)
zkc --help
zephyr-kconfig --help
```
## Add to your project
```bash
uv add zephyr-kconfig --dev
```
and then run the cli via
```bash
uv run zkc --help
```
## Features
Below examples are assuming you are running the tool globally
> Note - uvx does sandboxing (virtualenv) for you so no need to worry
### Get info on a KConfig item
```bash
# get the description as JSON output for CONFIG_LWM2M_SHELL
uvx zepyhr-kconfig --release 4.3.0 get CONFIG_LWM2M_SHELL
```
> A partial CONFIG spec will get all items that start with the provided input for
example CONFIG_LWM2M_ will output all L2M2M config items
> Use `--exact` to get the info on CONFIG_LWM2M only
> Use `--metadata` to get some extra fields (such as linenr, menupath etc)
> Use `--indent -1` to remove any indentation (default is 2)
### Get deps on a KConfig item
```bash
# get the dependencies for CONFIG_LWM2M_SHELL
uvx zepyhr-kconfig --release 4.3.0 deps CONFIG_LWM2M_SHELL
```
For above example output would be:
`CONFIG_LWM2M && CONFIG_NETWORKING`
> The input symbol should be exact
### Pretty Print KConfig item(s)
```bash
# show the description of symbol(s)
uvx zepyhr-kconfig --release 4.3.0 pprint CONFIG_LWM2M_SHELL
```
> Use `--exact` to print only one symbol