particle-cli

v3.25.1

Simple Node commandline application for working with your Particle devices and using the Particle Cloud For more information about how to use this package see README

Latest version published 8 days ago

License: Apache-2.0

NPM

GitHub

Package Health Score

73 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.25.1	\|	07/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.24.0	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.16.0	\|	09/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.53.0	\|	12/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.52.0	\|	11/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (100)

GitHub Stars: 212
Forks: 92
Contributors: 50

Direct Usage Popularity

The npm package particle-cli receives a total of 100 downloads a week. As such, we scored particle-cli popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package particle-cli, we found that it has been starred 212 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 50
Funding: No

With more than 10 contributors for the particle-cli repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like particle-cli is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 32
Open PR: 0
Last Release: 8 days ago
Last Commit: 2 months ago

Further analysis of the maintenance status of particle-cli based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that particle-cli demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12

Age: 9 years
Dependencies: 29 Direct
Versions: 202
Install Size: 1.87 MB
Dist-tags: 2
# of Files: 198
Maintainers: 2
TS Typings: No

particle-cli has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

GitHub Actions

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.

Particle CLI

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!

Installing

For end-users, the most up-to-date installation instructions can be found here: macOS / Linux | Windows

Note: Some commands may require openssl to be installed on your system. You can install it using your package manager (e.g. brew install openssl on macOS).

Getting Started

These next two commands are all you need to get started setting up an account, claiming a device, and discovering new features.

particle setup

Guides you through creating a new account, and claiming your device!

$ particle setup

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.

Command Reference

For the full list of commands, please see the CLI command reference.

Known Issues

The Wireless Photon Setup Wizard will only automatically switch networks on OS X. Users of other operating systems will need to manually connect their computer to the Photon's Wi-Fi. You will be prompted during the wizard when this is required.

Development

Currently development is supported on macOS only!

Installing

Install Node.js [node@16.x and npm@8.x are required]
Clone this repository $ git clone git@github.com:particle-iot/particle-cli.git && cd ./particle-cli
Install external tools: openssl (e.g. brew install openssl)
Install dependencies $ npm install
View available commands $ npm run
Run the tests $ npm test
Run the CLI $ npm start
Start Hacking!

Running

When developing, run individual commands using:

$ npm start -- - e.g. $ npm start -- library view dotstar --readme

Anything after the -- delimiter is passed directly to the CLI (docs).

To test the source as it will be published:

Register the particle command globally: $ npm link
Run commands: $ particle --help (using standard argument formatting)

Testing

The Particle CLI has a number of automated test suites and related commands. The most important are:

npm test - run all tests (NOTE: End-To-End tests require additional setup)
npm run lint - run the linter and print any errors to your terminal
npm run test:ci - run all tests excluding device-dependent end-to-end test as CI does
npm run test:unit - run unit tests
npm run test:integration - run integration tests
npm run coverage - report code coverage stats

All tests use mocha, chai, and sinon with coverage handled by nyc.

We recommend running locally if you can as it greatly shortens your feedback loop. However, CI also runs against every PR and error reporting is publicly available.

CLI Packaging and Distribution

Cli is packaged using pkg. The packaging is done using GitHub Actions and the executables are uploaded to binaries.particle.io/particle-cli.
There are two installers that are created for the CLI:
- Windows installer: particle-cli-setup.exe (This is an NSIS installer for Windows). You can see the installer script here ParticleCLISetup.nsi
- Unix installer: install-cli (This is a shell script that installs the CLI on Unix systems). You can see the installer script here install-cli.sh
The installers are created using GitHub Actions and are uploaded to binaries.particle.io/particle-cli/installer.
The current supported platforms for the CLI are:
- Windows
  - x64
- macOS
  - x64
  - arm64
- Linux
  - x64
  - arm64
  - arm

Releasing a new version

See RELEASE.md.

particle-cli development dependencies

chai chai-as-promised doctoc dotenv eslint eslint-config-particle execa github-api mocha mock-fs nock nyc pkg proxyquire sinon sinon-chai strip-ansi

FAQs

What is particle-cli?

Simple Node commandline application for working with your Particle devices and using the Particle Cloud. Visit Snyk Advisor to see a full health score report for particle-cli, including popularity, security, maintenance & community analysis.

Is particle-cli popular?

The npm package particle-cli receives a total of 100 weekly downloads. As such, particle-cli popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is particle-cli well maintained?

We found that particle-cli demonstrated a healthy version release cadence and project activity. It has a community of 50 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is particle-cli safe to use?

While scanning the latest version of particle-cli, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 26 July-2024, at 08:18 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (100)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Particle CLI

Table of Contents

Installing

Getting Started

particle setup

particle help

particle update

Command Reference

Known Issues

Development

Installing

Running

Testing

CLI Packaging and Distribution

Releasing a new version

particle-cli dependencies

particle-cli development dependencies

FAQs

What is particle-cli?

Is particle-cli popular?

Is particle-cli well maintained?

Is particle-cli safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues