Skip to main content

Getting the Admin CLI​

Clone this project using:

git clone https://github.com/espressif/esp-rainmaker-admin-cli.git

Setup Build Environment​

{{< hint type=note >}} If you are using esp-idf, the python and virtual environment requirement would already be fulfilled (via install.sh), and you can just install the dependencies using python -m pip install -r requirements.txt and move on to the next section which speaks about the workflow. {{< /hint >}}

Operating System requirements​

  • Linux / MacOS / Windows (standard distributions)

Other requirements​

To setup your build environment, please make sure you have the following installed on your host machine:

  • python (If not installed, please refer to https://www.python.org/)
  • pip (If not present, please refer to https://pip.pypa.io/en/stable/)
  • virtualenv (You can install using command - pip install virtualenv). This is not mandatory, but recommended so that rest of your python based utilities do not break.

The following python versions are supported:

  • python 3.5.x
  • python 3.6.x
  • python 3.7.x
  • python 3.8.x

Installing dependencies​

Once python and pip are installed, set up the virtual environment by following the instructions here. Thereafter, please enter the directory where this tool is installed (using terminal) and execute the below to install the dependencies:

pip install -r requirements.txt

OR

python -m pip install -r requirements.txt


## Resources

* Please get in touch with your ESP RainMaker contact in case of any issues or send an email to esp-rainmaker-support@espressif.com