CLI Usage

Setup

If you have not set up the ESP RainMaker command-line interface (CLI), follow the steps here before moving ahead with the usage.

If you are trying ESP RainMaker from China, please check out the additional instructions here.

Commands and Usage

1. Sign up using the following command:

esp-rainmaker-cli signup <email>

2. Log into the CLI using the following command:

esp-rainmaker-cli login [--email <email>]

If the email is not provided, a browser window will open for login.

3. After successful login, you can use the Rainmaker CLI.

Running the Utility

Usage

esp-rainmaker-cli [OPTIONS] COMMAND [ARGS]...

Options:

No.	Parameter	Description
1	-h, --help	show this help message and exit

Commands:

Run esp-rainmaker-cli {command} -h for additional help

No.	Parameter	Description
1	signup	Sign up for ESP Rainmaker
2	login	Login to ESP Rainmaker
3	logout	Logout current (logged-in) user
4	forgotpassword	Reset the password
5	getnodes	List all nodes associated with the user
6	getnodeconfig	Get node configuration
7	getnodestatus	Get online/offline status of the node
8	setparams	Set node parameters. Note: Enter JSON data in singe quotes
9	getparams	Get node parameters
10	removenode	Remove user-node mapping
11	provision	Provision the node to join Wi-Fi network
12	getmqtthost	Get the MQTT Host URL to be used in the firmware
13	claim	Claim the node connected to the given serial port (get cloud credentials)
14	otaupgrade	Upload OTA Firmware image and start OTA Upgrade
15	getuserinfo	Get details of current (logged-in) user
16	sharing	Node Sharing Operations
17	create_cmd_request	Create a Command Response Request (Beta)
18	get_cmd_requests	Get Command Response Requests (Beta)

Note: For esp-rainmaker-cli setparams command, the JSON data argument needs to be specified differently as per your Host OS.

MacOS/Linux: '{"Light": {"brightness": 50, "output": false}}'

Windows: "{\"Light\": {\"brightness\": 50, \"output\": false}}"