This is the Zephyr RTOS meta tool, west.
https://docs.zephyrproject.org/latest/guides/west/index.html
Installation
Using pip:
pip3 install west
(Use pip3 uninstall west to uninstall it.)
Basic Usage
West lets you manage multiple Git repositories under a single directory using a single file, called the west manifest file, or manifest for short. By default the manifest file is named west.yml. You use west init to set up this directory, then west update to fetch and/or update the repositories named in the manifest.
By default, west uses upstream Zephyr’s manifest file, but west doesn’t care if the manifest repository is zephyr or not. You can and are encouraged to make your own manifest repositories to meet your needs.
For more details, see the West guide in the Zephyr documentation.
Example usage using the upstream manifest file:
mkdir zephyrproject && cd zephyrproject west init west update
What just happened:
west init clones the upstream west manifest repository, which in this case is the zephyr repository. The manifest repository contains west.yml, a YAML description of the Zephyr installation, including Git repositories and other metadata.
west update clones the other repositories named in the manifest file, creating working trees in the installation directory zephyrproject.
Use west init -m to specify another manifest repository. Use --mr to use a revision to inialize from; if not given, the remote’s default branch is used. Use --mf to use a manifest file other than west.yml.
Additional Commands
West has multiple sub-commands. After running west init, you can run them from anywhere under zephyrproject.
For a list of available commands, run west -h. Get help on a command with west <command> -h.
West is extensible: you can add new commands to west without modifying its source code. See Extensions in the documentation for details.
Hacking on West
This section contains notes for getting started developing west itself.
pip offers many different ways to (download and) install Python software. Below are common ways relevant to west; for a complete list check https://pip.pypa.io/en/stable/topics/
Quick Install
If you are not interested in source code and git history, GitHub offers pip the ability to download and install a .zip archive of any random version with a single command. This allows testing work in progress very quickly. Examples:
pip3 uninstall west # Pull request 830 pip3 install --dry-run https://github.com/zephyrproject-rtos/west/archive/pull/830/head.zip # Release v1.4 pip3 install https://github.com/zephyrproject-rtos/west/archive/v1.4-branch.zip # Someone's random version pip3 install https://github.com/someone_you_trust/west/archive/some_branch_or_tag.zip
Warning: never install software from people or locations you do not trust!
Editable Install
To run west “live” from the current source code tree, run this command from the top level directory in the west repository:
pip3 install -e .
This is useful if you are actively working on west and don’t want to re-package and install a wheel each time you run it.
Creating a wheel package
You can create a wheel package and distribute it to others.
To build the west wheel file:
pip3 install --upgrade build python -m build
This will create a file named dist/west-x.y.z-py3-none-any.whl, where x.y.z is the current version in setup.py.
To install the wheel:
pip3 install -U dist/west-x.y.z-py3-none-any.whl
You can pip3 uninstall west to remove this wheel before re-installing the version from PyPI, etc.
Running the Tests
First, install tox:
# macOS, Windows pip3 install tox # Linux pip3 install --user tox
Then, run the test suite locally from the top level directory:
tox
You can use -- to tell tox to pass arguments to pytest. This is especially useful to focus on specific tests and save time. Examples:
# Run a subset of tests tox -- tests/test_project.py # Debug the ``test_update_narrow()`` code with ``pdb`` (but _not_ the # west code which is running in subprocesses) tox -- --verbose --exitfirst --trace -k test_update_narrow # Run all tests with "import" in their name and let them log to the # current terminal tox -- -v -k import --capture=no
The tests cannot be run with pytest directly, they require the tox environment.
See the tox configuration file, tox.ini, for more details.
1 maintainer
Release files for west 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| west-1.5.0.tar.gz | 149.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| west-1.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 256.3 kB
Release files / west-1.5.0.tar.gz
| Download URL | west-1.5.0.tar.gz |
|---|---|
| Size | 149.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7088fe0e9afe0719ebee95c51c529149f7bcfc919d83a8206d35fa9c683ed0a5
|
|
BLAKE2b-256 checksum How to use checksums |
548eddb81e2635e58d156092556934a2cffe245978c91e4a08e11d72591f46e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2025.
Transparency logRelease files / west-1.5.0-py3-none-any.whl
| Download URL | west-1.5.0-py3-none-any.whl |
|---|---|
| Size | 107.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f71411d11ed9ed00847405c6a83600374c2e0cf8676ed5af5d8b572f92c4765a
|
|
BLAKE2b-256 checksum How to use checksums |
c51de50fb71de492abb549917fdbf13c4a8a8459af9d78a2fa47905804905c36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2025.
Transparency log
