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
29.. toctree::
30   :maxdepth: 1
31
32   install.rst
33   release-notes.rst
34   troubleshooting.rst
35   basics.rst
36   built-in.rst
37   workspaces.rst
38   manifest.rst
39   config.rst
40   alias.rst
41   extensions.rst
42   build-flash-debug.rst
43   sign.rst
44   zephyr-cmds.rst
45   why.rst
46   moving-to-west.rst
47   without-west.rst
48
49For details on west's Python APIs, see :ref:`west-apis`.
50
51.. rubric:: Footnotes
52
53.. [#west-name]
54
55   Zephyr is an English name for the Latin `Zephyrus
56   <https://en.wiktionary.org/wiki/Zephyrus>`_, the ancient Greek god of the
57   west wind.
58
59.. _repository:
60   https://github.com/zephyrproject-rtos/west
61