https://github.com/andreasonny83/twilio-remote-cli
A Remote control for your Twilio API that runs inside your terminal
https://github.com/andreasonny83/twilio-remote-cli
cli node twilio twilio-api
Last synced: 3 months ago
JSON representation
A Remote control for your Twilio API that runs inside your terminal
- Host: GitHub
- URL: https://github.com/andreasonny83/twilio-remote-cli
- Owner: andreasonny83
- License: mit
- Created: 2018-11-14T08:05:48.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2020-10-03T14:46:54.000Z (over 5 years ago)
- Last Synced: 2025-02-02T04:41:13.207Z (12 months ago)
- Topics: cli, node, twilio, twilio-api
- Language: JavaScript
- Homepage:
- Size: 1020 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Twilio Remote CLI
[](https://badge.fury.io/js/twilio-remote-cli)
[](https://www.npmjs.com/package/twilio-remote-cli)
[](https://snyk.io/test/github/andreasonny83/twilio-remote-cli?targetFile=package.json)
[](http://commitizen.github.io/cz-cli/)
> A remote control for your Twilio API
## Prerequisites
The CLI has dependencies that require Node 6 or higher, together with NPM 3 or higher.
You will also need a Twilio account and phone number that can send SMS messages
(you can [sign up for a Twilio account for free here](https://www.twilio.com/try-twilio)).
## Table of Contents
- [Twilio Remote CLI](#twilio-remote-cli)
- [Prerequisites](#prerequisites)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Install Globally](#install-globally)
- [Run from npm without installing](#run-from-npm-without-installing)
- [Install a specific version (Example: 0.0.1)](#install-a-specific-version-example-001)
- [Usage](#usage)
- [Options](#options)
- [`--call`, `-c`](#--call--c)
- [`--digits`, `-d`](#--digits--d)
- [`--sms`, `-s`](#--sms--s)
- [`--message`, `-m`](#--message--m)
- [Configuration](#configuration)
- [Sending SMS](#sending-sms)
- [Making calls](#making-calls)
- [License](#license)
## Installation
**BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites)
### Install Globally
```sh
npm install -g twilio-remote-cli
```
### Run from npm without installing
```sh
npx twilio-remote-cli
```
### Install a specific version (Example: 0.0.1)
```sh
npm install -g twilio-remote-cli@0.0.1
```
## Usage
```
$ twilio-remote --help
Usage
$ twilio-remote
Options
--call, -c Perform a call against a given number
--digits -d Send some digits to the number when the call is answered
--sms, -s Deliver an sms to a given number (to be used in combination of --message)
--message, -m The message to be delivered to the given number (requires the --sms flag)
Example
$ twilio-remote
$ twilio-remote -c +1234567890
$ twilio-remote -c +1234567890 -d 123
$ twilio-remote -s +1234567890 -m Allo!
```
Then just follow the instructions on your terminal.
### Options
##### `--call`, `-c`
Perform a call against a given number
```
$ twilio-remote -c +1234567890
```
##### `--digits`, `-d`
**NOTE** This flag must be used in combination with `--call`
Send some DTMF (Dual-Tone Multi-Frequency Tones) tones to the number when the call is answered.
Have a look at [Twilio Studio Flow](https://www.twilio.com/console/studio/flows/).
Learn more how to use the [Gather Input On Call Twilio Widget from here](https://www.twilio.com/docs/studio/widget-library#gather-input-on-call)
If a certain number requires to enter a code when the call is answered, you can use `twilio-remote` in this way:
```
$ twilio-remote -c +1234567890 -d 123
```
##### `--sms`, `-s`
Deliver an sms to a given number
**NOTE** This flag must be used in combination with `--message`
```
$ twilio-remote -s +1234567890 -m Allo!
```
##### `--message`, `-m`
The message to be delivered to the given number
**NOTE** This flag must be used in combination with `--sms`
```
$ twilio-remote -s +1234567890 -m Allo!
```
## Configuration
Twilio Remote CLI make uses of the Twilio API by accessing you personal Twilio account.
We need to configure the application with our Twilio credentials. Gather your Twilio Account Sid and Auth Token from the [Twilio console](https://www.twilio.com/console) along with a [Twilio phone number](https://www.twilio.com/console/phone-numbers/incoming) that can send SMS messages.
Run the Twilio Remote CLI with
```sh
twilio-remote
```
Then select the `Setup Twilio Account` option and enter all the required information.
### Sending SMS
### Making calls
## License
MIT
---
Created with 🦄 by [andreasonny83](https://about.me/andreasonny83)