ESP RainMaker Customer Docs

ESP RainMaker Customer Docs

  • Get Started
  • Releases
  • Help

›CLIs

Introduction

  • Introduction

RainMaker Cloud

  • RainMaker Cloud
  • Prerequisites
  • Pre-Deployment Setup
  • Setup
  • Backend
  • Node Registration Module
  • Frontend
  • Post-Deployment Setup
  • Verification
  • Licensing
  • Deployment settings
  • Add-on services
  • Push Notifications
  • Upgrades
  • Configurations
  • Uninstall

Phone Apps

  • Android Configuration
  • iOS Configuration
  • Notification payloads

CLIs

  • CLI

Firmware

  • Firmware

3rd Party Logins

  • Sign-in with Google
  • Sign-in with Apple

Integrations

  • Voice Assistant Integrations
  • Alexa
  • Google Assistant
  • Voice Assistant Integrations AddOns repo
  • Alexa Account Linking
  • Publishing Alexa skill
  • Publishing GVA action
  • Upgrades

Features

  • Features

Monitoring

  • RainMaker Monitoring Dashboard

References

  • References

CLI

[中文版本]

There are two types of CLIs relevant for private RainMaker deployments.

RainMaker Admin CLI

This is mandatory to use for generating and registering the node credentials. Entire configuration and usage instructions can be found here.

RainMaker CLI

RainMaker CLI would typically not be required for the private deployments, since the phone apps would be the primary interfaces for end users. Even then, if you want to use it for testing, follow these instructions

  • Open the file esp-rainmaker/cli/rmaker_lib/serverconfig.py.
  • Search for the line HOST = 'https://api.rainmaker.espressif.com/' + VERSION + '/'
  • Replace https://api.rainmaker.espressif.com/ with your own Base URL. Follow Get Base Url steps to fetch the URL.

Note that, for private deployments, this CLI can be used only for email address + password based logins and that too only via the command line, not the web UI, since the web UI has quite some things specific for the public RainMaker deployment. Use this command for login

./rainmaker.py login --email abc@xyz.com
← Notification payloadsFirmware →
  • RainMaker Admin CLI
  • RainMaker CLI
Copyright © 2025 Espressif Systems