This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

Using Snippets


See Built-in snippets for a list of snippets that are provided by Zephyr.

Snippets have names. You use snippets by giving their names to the build system.

With west build

To use a snippet named foo when building an application app:

west build -S foo app

To use multiple snippets:

west build -S snippet1 -S snippet2 [...] app

With cmake

If you are running CMake directly instead of using west build, use the SNIPPET variable. This is a whitespace- or semicolon-separated list of snippet names you want to use. For example:

cmake -Sapp -Bbuild -DSNIPPET="snippet1;snippet2" [...]
cmake --build build

Application required snippets

If an application should always be compiled with a given snippet, it can be added to that application’s CMakeLists.txt file. For example:

if(NOT snippet1 IN_LIST SNIPPET)

find_package(Zephyr ....)