# join-api

> An unofficial CLI for Join by Joaoapps

Latest version **0.2.0** (published 2017-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install join-api
pnpm add join-api
yarn add join-api
bun add join-api
```

Provides the command `join-api`.

## 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.2.0 |
| Published | 2017-12-26 |
| First published | 2017-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Dan Mercer |
| Maintainers | drmercer |

## Links

- npm: https://www.npmjs.com/package/join-api
- Repository: https://gitlab.com/drmercer/join-api
- Homepage: https://gitlab.com/drmercer/join-api#README
- Issues: https://gitlab.com/drmercer/join-api/issues
- npm.io page: https://npm.io/package/join-api

## Dependencies (5)

- [conf](https://npm.io/package/conf.md) ^1.3.1
- [request](https://npm.io/package/request.md) ^2.83.0
- [build-url](https://npm.io/package/build-url.md) ^1.0.10
- [commander](https://npm.io/package/commander.md) ^2.12.2
- [password-prompt](https://npm.io/package/password-prompt.md) ^1.0.3

## Recent versions

- 0.2.0 (latest) — 2017-12-26
- 0.1.0 — 2017-12-26
- 0.0.1 — 2017-11-30

## README

# join-api

An unofficial command-line interface for [Join by Joaoapps](https://joaoapps.com/join/).

## Installation

```sh
$ npm install --global join-api
```

## Command-Line Usage

You will need your Join API key and device IDs, which you can get from the [Join web interface](https://joinjoaomgcd.appspot.com/).

To store your API key (this is important, sending won't work without it):
```sh
$ join-api set-key
Enter your API key: ******************************** # <-- Your API key
```

To add a device
```sh
$ join-api add-device <Your device ID> 'My Phone'
```

To send a URL to your device
```sh
$ join-api send --device 'My Phone' --url https://gitlab.com/
```

For full usage documentation, use `join-api -h` or `join-api help`.

## Usage in NodeJS

This package can also be imported as a module. Simply `require('join-api')`

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