跳到主要内容

CLI 设置

本文主要介绍如何设置 ESP RainMaker 命令行界面 (CLI) 工具。

安装 Python 3​

如果您已经安装 Python 3，请直接阅读下一节。如果没有安装，请按照以下步骤进行操作：

  1. 从 Python 网站 下载适用于您的操作系统的 Python 3。RainMaker CLI 测试使用的是 Python 3.7.4，但是使用最新版本也无大碍。
  2. 使用操作系统对应的安装程序来安装 Python 3。
  3. 在终端上运行以下命令，验证安装是否成功。
$ python3 --version

注意：在 Windows 上，使用 python --version 来验证安装是否成功。

安装依赖项​

首先安装 Python 包安装器 pip，然后安装依赖项。以下是具体步骤：

安装 pip

$ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
$ python3 get-pip.py

注意：在 Windows 上，使用 python get-pip.py 来安装 pip。

安装依赖项

$ cd /path/to/esp-rainmaker/cli/
$ pip3 install -r requirements.txt

注意：使用 CLI 之前需要在您的主机上设置 ESP-IDF。如果您没有设置过 ESP-IDF，请参考 ESP-IDF 入门指南 进行设置并确保 IDF_PATH 设置正确。

将 CLI 添加到您的 PATH（可选）[仅适用于 macOS 和 Linux]​

RainMaker CLI 可以直接从 esp-rainmaker-cli 文件夹中使用，如下所示：

$ ./rainmaker.py <cmd>

但是，如果您想在其他路径下使用 RainMaker CLI，请将它添加到您的 PATH 变量中，步骤如下：

  1. 在编辑器中打开 ~/.bash_profile 或 ~/.profile 文件。
  2. 在末尾添加 export PATH=$PATH:/path/to/esp-rainmaker/cli 行
  3. 保存 .bash_profile 或 .profile 文件。
  4. 根据实际情况，重启终端，或者执行 $ source ~/.bash_profile 或 $ source ~/.profile。