安装 west

West 使用 Python 3 编写，通过 PyPI 分发。使用 pip3 安装或升级 west：

在 Linux 上:

pip3 install --user -U west

在 Windows 和 macOS 上:

pip3 install -U west

备注

有关 --user 选项用法的更多说明，参见 Python 与 pip。

之后可以运行 pip3 show -f west，查看 west 可执行文件及相关文件的安装位置。

安装 west 后，即可使用它 克隆 Zephyr 仓库。

结构

West 的代码通过 PyPI 上名为 west 的 Python 包分发。此发行包包含一个启动器可执行文件，也名为 west （Windows 上为 west.exe）。

安装 west 时，pip3 会将启动器放到用户文件系统中的某个位置（具体位置取决于操作系统，但应位于 PATH 环境变量 中）。此启动器是运行 west init、west update 等内置命令以及工作区中发现的扩展命令的命令行入口。

除命令行接口外，还可以直接使用 west 的 Python API。详见 West API。

启用 shell 补全

West 目前支持以下 shell 的补全：

  • bash

  • zsh

  • fish

  • powershell（仅支持开发板限定符）

要启用 shell 补全，需要获取相应的补全脚本，并在当前 shell 中加载它。补全脚本的使用方式如下：

一次性设置：

source <(west completion bash)

永久设置：

west completion bash > ~/west-completion.bash; printf '\n%s\n' "source ~/west-completion.bash" >> ~/.bashrc