1.. _west:
2
3West (Zephyr's meta-tool)
4#########################
5
6The Zephyr project includes a swiss-army knife command line tool named
7``west``\ [#west-name]_. West is developed in its own `repository`_.
8
9West's built-in commands provide a multiple repository management system with
10features inspired by Google's Repo tool and Git submodules. West is also
11"pluggable": you can write your own west extension commands which add
12additional features to west. Zephyr uses this to provide conveniences for
13building applications, flashing and debugging them, and more.
14
15Like ``git`` and ``docker``, the top-level ``west`` command takes some common
16options, a sub-command to run, and then options and arguments for that
17sub-command::
18
19  west [common-opts] <command> [opts] <args>
20
21Since west v0.8, you can also run west like this::
22
23  python3 -m west [common-opts] <command> [opts] <args>
24
25You can run ``west --help`` (or ``west -h`` for short) to get top-level help
26for available west commands, and ``west <command> -h`` for detailed help on
27each command.
28
29The following pages document west's ``v0.11.x`` releases, and provide additional
30context about the tool.
31
32.. toctree::
33   :maxdepth: 1
34
35   install.rst
36   release-notes.rst
37   troubleshooting.rst
38   basics.rst
39   built-in.rst
40   workspaces.rst
41   manifest.rst
42   config.rst
43   extensions.rst
44   build-flash-debug.rst
45   sign.rst
46   zephyr-cmds.rst
47   why.rst
48   moving-to-west.rst
49   without-west.rst
50
51For details on west's Python APIs, see :ref:`west-apis`.
52
53.. rubric:: Footnotes
54
55.. [#west-name]
56
57   Zephyr is an English name for the Latin `Zephyrus
58   <https://en.wiktionary.org/wiki/Zephyrus>`_, the ancient Greek god of the
59   west wind.
60
61.. _repository:
62   https://github.com/zephyrproject-rtos/west
63