xref: /aosp_15_r20/external/pigweed/pw_env_setup_zephyr/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_env_setup_zephyr:
2
3.. rst-class:: with-subtitle
4
5===================
6pw_env_setup_zephyr
7===================
8.. pigweed-module::
9   :name: pw_env_setup_zephyr
10
11   * **Integrate your Pigweed environment with Zephyr**
12
13---------------------
14Zephyr kick the tires
15---------------------
16The ultimate goal of this module is to provide tools and utilities for
17integrating your Zephyr + Pigweed project. Some code in this python module will
18be used in the ``pw`` CLI, while other code will be leveraged by other
19utilities. This module is experimental so watch out for changes.
20
21Check out the Zephyr getting started guide at :ref:`docs-os-zephyr`.
22
23-----------
24CLI options
25-----------
26This module offers a CLI integrated with the ``pw`` command as ``pw west`` which
27provides an easy way to work with both Zephyr + Pigweed:
28
29.. list-table::
30   :header-rows: 1
31
32   * - Flag
33     - Description
34   * - ``-v``
35     - Print verbose messages (debug)
36
37.. list-table::
38   :header-rows: 1
39
40   * - Subcommand
41     - Description
42   * - ``manifest``
43     - Print a simple West manifest which includes this instance of Pigweed and
44       optionally the bundled version of Zephyr if ``pw package install zephyr``
45       was run.
46