Name: particle-cli
Owner: Particle
Description: Command Line Interface for Particle Cloud and devices
Created: 2015-05-13 17:05:39.0
Updated: 2018-05-16 02:32:11.0
Pushed: 2018-05-07 22:57:13.0
Size: 7635
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Particle's full-stack Internet of Things (IoT) device platform gives you everything you need to securely and reliably connect your IoT devices to the web. For more details please visit www.particle.io.
The Particle CLI is a powerful tool for interacting with your IoT devices and the Particle Cloud. The CLI uses node.js and can run on Windows, Mac OS X, and Linux. It's also open source so you can edit and change it, and even send in your changes as pull requests if you want to share!
For the most up-to-date installation instructions, including Windows installer, see CLI - Installation on our documentation site.
To make sure you are running the latest version of particle-cli, type the following command:
unning from source (advanced)
rab the CLI source and play with it locally
git clone git@github.com:particle-iot/particle-cli.git cd particle-cli npm install node bin/particle help
START doctoc generated TOC please keep comment here to allow auto update -->
DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
able of Contents
[Getting Started](#getting-started)
- [particle setup](#particle-setup)
- [particle help](#particle-help)
[Updating Firmware](#updating-firmware)
- [Photon/P1/Electron](#photonp1electron)
- [particle update](#particle-update)
[Command Reference](#command-reference)
evelopment](#development)
[Releasing a new version](#releasing-a-new-version)
[Updating system firmware](#updating-system-firmware)
END doctoc generated TOC please keep comment here to allow auto update -->
etting Started
ese next two commands are all you need to get started setting up an account, claiming a device, and discovering new features.
particle setup
ides you through creating a new account, and claiming your device!
$ particle setup
particle help
ows 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
pdating Firmware
Photon/P1/Electron
particle update
ou wish to easily update the system firmware running on your device to a later version, you can use the `particle update` command. For the exact version it will update to, check the version of the files in the [updates folder](/assets/updates).
ake sure you have [DFU-util](http://dfu-util.sourceforge.net/) installed.
onnect your device via USB, and put it into [DFU mode](https://docs.particle.io/guide/getting-started/modes/#dfu-mode-device-firmware-upgrade-).
un `particle update`.
ommand Reference
the full list of commands, please see the [CLI command reference](https://docs.particle.io/reference/cli/).
velopment
e the repository and run `npm install`.
nsure compatibility with versions of Node 4 and later, the code in
` is transpiled using Babel and output to `dist`. This means you
run `npm run compile` to have changes in `src` be taken into account.
un in development mode using the files from `src` directly, run
PARTICLE_CLI_DEVELOPMENT=1 bin/particle.js
pdating system firmware
pm run update-firmware-binaries <version>`
ere `<version>` is the newly released system firmware version like 0.7.0
st on each platform by doing
bin/particle.js serial inspect
bin/particle.js update
bin/particle.js serial inspect
not update the versions or CHANGELOG.md just yet!
mmit as something like "adds firmware binaries for 0.7.0" and preceed to release a new CLI version (below).
eleasing a new version
[RELEASE.md](RELEASE.md).