2018-06-08 09:46:50 +08:00
|
|
|
.. _west:
|
|
|
|
|
|
2019-01-27 05:12:48 +08:00
|
|
|
West (Zephyr's meta-tool)
|
|
|
|
|
#########################
|
2018-06-08 09:46:50 +08:00
|
|
|
|
2019-02-14 06:05:47 +08:00
|
|
|
The Zephyr project includes a swiss-army knife command line tool named
|
|
|
|
|
``west``\ [#west-name]_. West is developed in its own `repository`_. Like
|
|
|
|
|
``git`` and ``docker``, the top-level ``west`` command takes some common
|
|
|
|
|
options, a sub-command to run, and then options and arguments for that
|
|
|
|
|
sub-command::
|
2018-06-08 09:46:50 +08:00
|
|
|
|
2019-02-14 06:05:47 +08:00
|
|
|
west [common-opts] <command> [opts] <args>
|
2018-11-12 23:56:09 +08:00
|
|
|
|
2019-04-03 03:55:25 +08:00
|
|
|
West's built-in commands provide a multiple repository management
|
|
|
|
|
system with features inspired by Google's Repo tool and Git
|
|
|
|
|
submodules. West simplifies configuration and is also pluggable: you
|
|
|
|
|
can write your own west "extension commands" which add additional
|
|
|
|
|
features to west. Zephyr uses this feature to provide conveniences
|
|
|
|
|
for building applications, flashing and debugging them, and more.
|
|
|
|
|
|
|
|
|
|
It is possible not to use west for Zephyr development if you do not
|
|
|
|
|
require these features, prefer to use your own tools, or want to
|
|
|
|
|
eliminate the extra layer of indirection. However, this implies extra
|
|
|
|
|
effort and expert knowledge.
|
2018-11-12 23:56:09 +08:00
|
|
|
|
2019-02-14 06:05:47 +08:00
|
|
|
You can run ``west --help`` (or ``west -h`` for short) to get top-level help
|
|
|
|
|
for available west commands, and ``west <command> -h`` for detailed help on
|
|
|
|
|
each command.
|
2018-06-08 09:46:50 +08:00
|
|
|
|
2019-07-23 01:00:59 +08:00
|
|
|
The following pages document west's ``v0.6.x`` releases, and provide additional
|
2019-02-14 06:05:47 +08:00
|
|
|
context about the tool.
|
2018-06-08 09:46:50 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2018-11-12 23:56:09 +08:00
|
|
|
:maxdepth: 1
|
2018-06-08 09:46:50 +08:00
|
|
|
|
2019-05-09 00:07:01 +08:00
|
|
|
install.rst
|
2019-08-28 14:42:01 +08:00
|
|
|
moving-to-west.rst
|
|
|
|
|
troubleshooting.rst
|
2018-11-02 05:02:30 +08:00
|
|
|
repo-tool.rst
|
2019-02-14 06:05:47 +08:00
|
|
|
manifest.rst
|
|
|
|
|
config.rst
|
|
|
|
|
extensions.rst
|
2019-02-08 01:16:49 +08:00
|
|
|
build-flash-debug.rst
|
2019-02-14 06:05:47 +08:00
|
|
|
sign.rst
|
2019-05-12 15:52:42 +08:00
|
|
|
zephyr-cmds.rst
|
2019-01-30 16:40:55 +08:00
|
|
|
why.rst
|
|
|
|
|
without-west.rst
|
|
|
|
|
planned.rst
|
2019-06-14 04:16:32 +08:00
|
|
|
release-notes.rst
|
2018-06-08 09:46:50 +08:00
|
|
|
|
2019-07-23 01:00:22 +08:00
|
|
|
For details on west's Python APIs, see :ref:`west-apis`.
|
2018-06-08 09:46:50 +08:00
|
|
|
|
2019-02-14 06:05:47 +08:00
|
|
|
.. rubric:: Footnotes
|
|
|
|
|
|
|
|
|
|
.. [#west-name]
|
|
|
|
|
|
|
|
|
|
Zephyr is an English name for the Latin `Zephyrus
|
|
|
|
|
<https://en.wiktionary.org/wiki/Zephyrus>`_, the ancient Greek god of the
|
|
|
|
|
west wind.
|
|
|
|
|
|
|
|
|
|
.. _repository:
|
2018-06-08 09:46:50 +08:00
|
|
|
https://github.com/zephyrproject-rtos/west
|
