# ab-pushbullet-cli

> PushBullet Command Line Client

Latest version **0.1.0** (published 2015-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install ab-pushbullet-cli
pnpm add ab-pushbullet-cli
yarn add ab-pushbullet-cli
bun add ab-pushbullet-cli
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-03-29 |
| First published | 2015-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alex Borisov |
| Maintainers | alexborisov |
| Keywords | pushbullet, cli, push, notification, android, ios, nodejs, node, iojs, io |

## Links

- npm: https://www.npmjs.com/package/ab-pushbullet-cli
- Repository: https://github.com/alexborisov/pushbullet-cli
- Issues: https://github.com/alexborisov/pushbullet-cli/issues
- npm.io page: https://npm.io/package/ab-pushbullet-cli

## Dependencies (4)

- [dotenv](https://npm.io/package/dotenv.md) ^1.0.0
- [commander](https://npm.io/package/commander.md) ^2.7.1
- [easy-table](https://npm.io/package/easy-table.md) ^0.3.0
- [pushbullet](https://npm.io/package/pushbullet.md) ^1.4.3

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-03-29

## README

# PushBullet CLI Client

Send PushBullet notifications to your devices via the command line.

The primary motivation for this project was to allow for an easy way to push notifications in response to system events.
For example: notifying that a download has completed or that a build task has finished.

## BIG FAT DISCLAMER

This code uses features of **ES6** and was developed against the _io.js_ fork of _node.js_.
It should run with vanilla _node.js_, but your mileage may vary!

## Installing

This utility is designed to be light and simple with minimal dependencies and configuration.

First download all dependencies

```
npm install
```

You will then need to obtain your API key from your PushBullet _Account Settings_.

Configure _pushbullet-cli_ to use your key

```
node pushbullet --key YOUR_KEY
```

Where `YOUR_KEY` is the API key you obtained from your PushBullet _Account Settings_.

Done! Ready to roll.

**NOTE:** Your key will be stored under your OS _user data_ folder in a file `.pbcli`. Running `--key` again will override this file.

## Usage

### Broadcast a simple note to all devices

```
node pushbullet "This is a test"
```

### Specify a title

You can set a custom title using the `--title` option

```
node pushbullet --title "Test Note" "This is a test"
```

### Push to a device

You can push to a specific device using the `-d` option and mirrors the _node-pushbullet-api_ api:

* If it is a string containing an '@' it is treated as an email address.
* If it is a string not containing an '@' it is treated as a device iden.
* If it is a number it is treated as a device id.
* If it is an object it is assumed to have one of the 'target parameters' as defined on https://docs.pushbullet.com/v2/pushes/ as an attribute. It can also have an optional source_device_iden attribute. If the object is empty, {}, then the push is sent to all devices.

```
node pushbullet -d my-device "This is a test"
```

In addition you may also push to a group of devices:

```
node pushbullet -d [my-device, another-device] "This is a test"
```

### Return a list of devices

```
node pushbullet --devices
```

## Planned Features

* Specify the notification type with the `-t` option
* Update a prior push `-u`
* Return the push history `--history`

## Contributing

This is a utility project written to scratch an itch. It works for my use cases. While I plan to periodically develop it further, this project is not amazingly high on my priority list.

**Pull requests are very welcome** if you wish to contribute features, fixes etc... I only ask that you try to keep your code minimalistic, clean and performance oriented.

---
_Source: https://npm.io/package/ab-pushbullet-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._