Skip to content

Commit f020474

Browse files
Mohammad-KhalidMohammad-Khalid
committed
plugin-autopilot v0.0.0
1 parent b731e98 commit f020474

File tree

9 files changed

+3199
-2
lines changed

9 files changed

+3199
-2
lines changed

‎.editorconfig

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
10+
[*.md]
11+
trim_trailing_whitespace = false

‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
*-debug.log
2+
*-error.log
3+
/.nyc_output
4+
/dist
5+
/tmp
6+
/yarn.lock
7+
node_modules
8+
test

‎README.md

+214-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,215 @@
1-
# Twilio Autopilot Plugin for the Twilio CLI
1+
Twilio Autopilot Plugin for the Twilio CLI
2+
================
23

3-
A plugin for the [Twilio CLI](https://github.com/twilio/twilio-cli) that merges and extends functionality from the [Autopilot CLI](https://github.com/twilio/autopilot-cli).
4+
A plugin for the [Twilio CLI](https://github.com/twilio/twilio-cli) that merges and extends functionality from the [Autopilot CLI](https://github.com/tingiris/twilio-cli-autopilot-plugin).
5+
6+
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7+
[![Version](https://img.shields.io/npm/v/plugin-autopilot.svg)](https://npmjs.org/package/plugin-autopilot)
8+
[![Downloads/week](https://img.shields.io/npm/dw/plugin-autopilot.svg)](https://npmjs.org/package/plugin-autopilot)
9+
[![License](https://img.shields.io/npm/l/plugin-autopilot.svg)](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/master/package.json)
10+
11+
<!-- toc -->
12+
13+
- [Requirements](#requirements)
14+
- [Install the Twilio CLI](#install-the-twilio-cli)
15+
- [Usage](#usage)
16+
- [Commands](#commands)
17+
- [`twilio autopilot:create`](#twilio-autopilotcreate)
18+
- [`twilio autopilot:list`](#twilio-autopilotlist)
19+
- [`twilio autopilot:update`](#twilio-autopilotupdate)
20+
- [`twilio autopilot:delete`](#twilio-autopilotdelete)
21+
- [`twilio autopilot:export`](#twilio-autopilotexport)
22+
- [`twilio autopilot:simulate]`](#twilio-autopilotsimulate)
23+
- [`twilio autopilot:field]`](#twilio-autopilotfield)
24+
- [`twilio autopilot:import [TYPE]`](#twilio-autopilotimport-type)
25+
<!-- tocstop -->
26+
27+
# Requirements
28+
29+
## Install the Twilio CLI
30+
31+
Via `npm` or `yarn`:
32+
33+
```sh-session
34+
$ npm install -g twilio-cli
35+
$ yarn global add twilio-cli
36+
```
37+
38+
Via `homebrew`:
39+
40+
```sh-session
41+
$ brew tap twilio/brew && brew install twilio
42+
```
43+
44+
# Usage
45+
46+
```sh-session
47+
$ twilio plugins:install @plugin-autopilot
48+
$ twilio --help autopilot
49+
USAGE
50+
$ twilio autopilot
51+
...
52+
```
53+
54+
# Commands
55+
56+
<!-- commands -->
57+
58+
- [Requirements](#requirements)
59+
- [Install the Twilio CLI](#install-the-twilio-cli)
60+
- [Usage](#usage)
61+
- [Commands](#commands)
62+
- [`twilio autopilot:create`](#twilio-autopilotcreate)
63+
- [`twilio autopilot:list`](#twilio-autopilotlist)
64+
- [`twilio autopilot:update`](#twilio-autopilotupdate)
65+
- [`twilio autopilot:delete`](#twilio-autopilotdelete)
66+
- [`twilio autopilot:export`](#twilio-autopilotexport)
67+
- [`twilio autopilot:simulate]`](#twilio-autopilotsimulate)
68+
- [`twilio autopilot:field]`](#twilio-autopilotfield)
69+
- [`twilio autopilot:import [TYPE]`](#twilio-autopilotimport-type)
70+
71+
## `twilio autopilot:create`
72+
73+
Create an assistant
74+
```
75+
USAGE
76+
$ twilio autopilot:create
77+
78+
OPTIONS
79+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
80+
81+
-o=(columns|json|tsv) [default: columns] Format of command output.
82+
83+
-p, --profile=profile Shorthand identifier for your profile.
84+
85+
-s, --schema=schema (required) [default: templates] schema path
86+
87+
--account-sid=account-sid Access resources for the specified account.
88+
```
89+
90+
## `twilio autopilot:list`
91+
92+
List all autopilot assistant
93+
```
94+
USAGE
95+
$ twilio autopilot:list
96+
97+
OPTIONS
98+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
99+
100+
-o=(columns|json|tsv) [default: columns] Format of command output.
101+
102+
-p, --profile=profile Shorthand identifier for your profile.
103+
104+
--account-sid=account-sid Access resources for the specified account.
105+
106+
--properties=properties [default: sid, uniqueName, friendlyName] The Autopilot Assistant List.
107+
```
108+
109+
## `twilio autopilot:update`
110+
111+
Update an assistant
112+
```
113+
USAGE
114+
$ twilio autopilot:update
115+
116+
OPTIONS
117+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
118+
119+
-o=(columns|json|tsv) [default: columns] Format of command output.
120+
121+
-p, --profile=profile Shorthand identifier for your profile.
122+
123+
-s, --schema=schema (required) schema path
124+
125+
--account-sid=account-sid Access resources for the specified account.
126+
```
127+
128+
## `twilio autopilot:delete`
129+
130+
Delete an assistant
131+
```
132+
USAGE
133+
$ twilio autopilot:delete
134+
135+
OPTIONS
136+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
137+
138+
-o=(columns|json|tsv) [default: columns] Format of command output.
139+
140+
-p, --profile=profile Shorthand identifier for your profile.
141+
142+
-s, --assistantSid=assistantSid (required) assistant sid
143+
144+
--account-sid=account-sid Access resources for the specified account.
145+
```
146+
147+
## `twilio autopilot:export`
148+
149+
Export an assistant
150+
```
151+
USAGE
152+
$ twilio autopilot:export
153+
154+
OPTIONS
155+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
156+
157+
-o=(columns|json|tsv) [default: columns] Format of command output.
158+
159+
-p, --profile=profile Shorthand identifier for your profile.
160+
161+
--account-sid=account-sid Access resources for the specified account.
162+
```
163+
164+
## `twilio autopilot:simulate`
165+
166+
Simulate an assistant
167+
```
168+
USAGE
169+
$ twilio autopilot:simulate
170+
171+
OPTIONS
172+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
173+
174+
-o=(columns|json|tsv) [default: columns] Format of command output.
175+
176+
-p, --profile=profile Shorthand identifier for your profile.
177+
178+
-s, --assistantSid=assistantSid (required) assistant sid
179+
180+
-t, --text=text (required) User text input
181+
182+
--account-sid=account-sid Access resources for the specified account.
183+
```
184+
185+
## `twilio autopilot:import [TYPE]`
186+
187+
Import a DialogFlow Agent/Alexa Interaction Model
188+
```
189+
USAGE
190+
$ twilio autopilot:import [TYPE]
191+
192+
ARGUMENTS
193+
TYPE (dialogflow|alexa) [default: dialogflow] Type of import DialogFlow/Alexa
194+
195+
OPTIONS
196+
-a, --dfagent=dfagent Dialogflow Agent Name
197+
198+
-b, --dfbackup=dfbackup Dialogflow Agent Backup Zip File Local Path
199+
200+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
201+
202+
-m, --model=model Alexa Interaction Model File Path
203+
204+
-o=(columns|json|tsv) [default: columns] Format of command output.
205+
206+
-p, --profile=profile Shorthand identifier for your profile.
207+
208+
-r, --redirectURL=redirectURL [default: https://inquisitive-stretch-2083.twil.io/generic] Alexa Back-End Hanlder URL to send back the response
209+
210+
--account-sid=account-sid Access resources for the specified account.
211+
212+
DESCRIPTION
213+
- twilio autopilot:import dialogflow --dfbackup <dialogflow-backup-zip-file> --dfagent <dialogflow-agent-name>
214+
- twilio autopilot:import alexa --model <alexa-interaction-model-file> [--redirectURL <alexa-back-end-hanlder-url>]
215+
```

‎bin/run

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env node
2+
3+
require('@oclif/command').run()
4+
.then(require('@oclif/command/flush'))
5+
.catch(require('@oclif/errors/handle'))

‎bin/run.cmd

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@echo off
2+
3+
node "%~dp0\run" %*

0 commit comments

Comments
 (0)