Getting started with CLI
These next two commands are all you need to get started setting up an account, claiming a device, and discovering new features.
particle login
Authenticate with your Particle account:
$ particle login
Follow the prompts in your terminal to complete the login.
If you don’t already have a Particle account, you can create one here.
particle help
Shows you what commands are available, and how to use them. You can also give the name of a command for detailed help.
$ particle help
$ particle help keys
particle update
If you wish to easily update Device OS on your device to a later version, you can use the particle update command.
You can specify a version with the --target argument.
- Connect your device via USB
- Run
particle update.
Quick Reference
| Command | Description |
|---|---|
particle login | Log in to your Particle account |
particle list | List all devices linked to your account |
particle device add <id> | Claim a new device |
particle device rename <id> <name> | Rename a device |
particle flash --usb firmware.bin | Flash firmware over USB |
particle flash <device-name> firmware.bin | Flash firmware OTA |
particle call <device-name> <function> | Call a function on a device |
particle get <device-name> <variable> | Read a variable value |
particle subscribe <event> | Subscribe to events from the cloud |
particle project create <name> | Create a new project directory |
particle compile <platform> . | Compile a project for a given platform |
Command Reference
For the full list of commands, please see the CLI command reference.
Troubleshooting
For detailed help with common issues, see the Particle CLI Troubleshooting Guide. This resource provides step-by-step solutions for installation errors, PATH configuration problems, permission issues, and connectivity challenges.