Skip to content

Particle CLI

The Particle command line interface (CLI) allows you to perform several important operations on your device locally. This can be more convenient than using the Web console. To get started:

Changing modes

Particle device have several operating modes, and you can tell which mode the device is in by the way the onboard LED is flashing. To change from one mode to another, you need to use both of the onboard buttons. Holding down the left button, push and release the right button. While both buttons are pressed, the LED shows stead white. After releasing the right button, the LED cycles through a series of flash patterns. When it reaches the mode you want, release the left button.

Update device OS over serial

  1. Connect to serial
  2. Update cli
  3. Put device into DFU mode
  4. particle update

Log into your Particle account

  1. particle login
  2. Enter your details at the prompts

Claim device

  1. Put device into listening mode
  2. particle identify
  3. Copy device id (24 hex characters)
  4. Connect device to wifi - may take a minute or so
  5. Claim the device with the command particle device add <device_id> replacing with the 16 character value you copied earlier

Unclaim device

  1. Make sure the device is connected to the Particle console
  2. Open the Particle CLI and type the command particle remove <device_id> where is the 16-character hex identifier for the device.