Skip to content

Commit d0ca1c2

Browse files
authored
Improve readability and organization
Removed serverless commands and re-organized to improve readability
1 parent 8efd8c7 commit d0ca1c2

File tree

1 file changed

+136
-161
lines changed

1 file changed

+136
-161
lines changed

README.md

Lines changed: 136 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -44,35 +44,55 @@ USAGE
4444
# Commands
4545

4646
<!-- commands -->
47+
48+
_Assistants_
49+
4750
* [`twilio autopilot:create`](#twilio-autopilotcreate)
4851
* [`twilio autopilot:delete`](#twilio-autopilotdelete)
49-
* [`twilio autopilot:deploy`](#twilio-autopilotdeploy)
5052
* [`twilio autopilot:export`](#twilio-autopilotexport)
53+
* [`twilio autopilot:list`](#twilio-autopilotlist)
54+
* [`twilio autopilot:update`](#twilio-autopilotupdate)
55+
56+
_Fields and Field Types
57+
5158
* [`twilio autopilot:fields:create`](#twilio-autopilotfieldscreate)
5259
* [`twilio autopilot:fields:delete`](#twilio-autopilotfieldsdelete)
5360
* [`twilio autopilot:fields:list`](#twilio-autopilotfieldslist)
5461
* [`twilio autopilot:fieldtypes:create`](#twilio-autopilotfieldtypescreate)
5562
* [`twilio autopilot:fieldtypes:list`](#twilio-autopilotfieldtypeslist)
5663
* [`twilio autopilot:fieldtypes:update`](#twilio-autopilotfieldtypesupdate)
5764
* [`twilio autopilot:fieldvalues:upload`](#twilio-autopilotfieldvaluesupload)
58-
* [`twilio autopilot:import [TYPE]`](#twilio-autopilotimport-type)
59-
* [`twilio autopilot:init`](#twilio-autopilotinit)
60-
* [`twilio autopilot:list`](#twilio-autopilotlist)
61-
* [`twilio autopilot:modelbuilds:create`](#twilio-autopilotmodelbuildscreate)
62-
* [`twilio autopilot:queries:export`](#twilio-autopilotqueriesexport)
63-
* [`twilio autopilot:samples:upload`](#twilio-autopilotsamplesupload)
64-
* [`twilio autopilot:simulate`](#twilio-autopilotsimulate)
65+
66+
67+
_Tasks and Samples_
68+
6569
* [`twilio autopilot:tasks:create`](#twilio-autopilottaskscreate)
6670
* [`twilio autopilot:tasks:delete`](#twilio-autopilottasksdelete)
6771
* [`twilio autopilot:tasks:list`](#twilio-autopilottaskslist)
6872
* [`twilio autopilot:tasks:update`](#twilio-autopilottasksupdate)
69-
* [`twilio autopilot:update`](#twilio-autopilotupdate)
73+
* [`twilio autopilot:samples:upload`](#twilio-autopilotsamplesupload)
74+
75+
76+
_Import bots from other platforms_
77+
78+
* [`twilio autopilot:import [TYPE]`](#twilio-autopilotimport-type)
79+
80+
_Webhooks
81+
7082
* [`twilio autopilot:webhooks:create`](#twilio-autopilotwebhookscreate)
7183
* [`twilio autopilot:webhooks:delete`](#twilio-autopilotwebhooksdelete)
7284
* [`twilio autopilot:webhooks:list`](#twilio-autopilotwebhookslist)
7385
* [`twilio autopilot:webhooks:update`](#twilio-autopilotwebhooksupdate)
86+
87+
_Other commands_
88+
89+
* [`twilio autopilot:modelbuilds:create`](#twilio-autopilotmodelbuildscreate)
90+
* [`twilio autopilot:simulate`](#twilio-autopilotsimulate)
91+
* [`twilio autopilot:queries:export`](#twilio-autopilotqueriesexport)
7492
* [`twilio help [COMMAND]`](#twilio-help-command)
7593

94+
# Usage
95+
7696
## `twilio autopilot:create`
7797

7898
Create an assistant
@@ -104,49 +124,52 @@ OPTIONS
104124

105125
_See code: [src/commands/autopilot/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/delete.js)_
106126

107-
## `twilio autopilot:deploy`
127+
## `twilio autopilot:export`
108128

109-
Deploys existing functions and assets to Twilio
129+
Export an assistant
110130

111131
```
112132
USAGE
113-
$ twilio autopilot:deploy
133+
$ twilio autopilot:export
114134
115135
OPTIONS
116-
-c, --config=config [default: .twilio-functions] Location of the config file. Absolute path or relative
117-
to current working directory (cwd)
118-
119-
-l, --logLevel=logLevel [default: info] Level of logging messages.
136+
-p, --profile=profile Shorthand identifier for your profile.
137+
-s, --assistant-sid=assistant-sid assistant sid
138+
--unique-name=unique-name assistant unique name
139+
```
120140

121-
-p, --profile=profile Shorthand identifier for your profile.
141+
_See code: [src/commands/autopilot/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/export.js)_
122142

123-
-t, --target=all|function|model [default: all] deploy function, model or all of them. Options can only be "all",
124-
"function" or "model".
143+
## `twilio autopilot:list`
125144

126-
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise
145+
List all autopilot assistant
127146

128-
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise
147+
```
148+
USAGE
149+
$ twilio autopilot:list
129150
130-
--override-existing-project Deploys Serverless project to existing service if a naming conflict has been found.
151+
OPTIONS
152+
-p, --profile=profile Shorthand identifier for your profile.
153+
--properties=properties [default: sid, uniqueName, friendlyName] The Autopilot Assistant List
131154
```
132155

133-
_See code: [src/commands/autopilot/deploy.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/deploy.js)_
156+
_See code: [src/commands/autopilot/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/list.js)_
134157

135-
## `twilio autopilot:export`
158+
## `twilio autopilot:update`
136159

137-
Export an assistant
160+
Update an assistant
138161

139162
```
140163
USAGE
141-
$ twilio autopilot:export
164+
$ twilio autopilot:update
142165
143166
OPTIONS
144-
-p, --profile=profile Shorthand identifier for your profile.
145-
-s, --assistant-sid=assistant-sid assistant sid
146-
--unique-name=unique-name assistant unique name
167+
-p, --profile=profile Shorthand identifier for your profile.
168+
-s, --schema=schema (required) schema path
169+
--unique-name=unique-name assistant unique name
147170
```
148171

149-
_See code: [src/commands/autopilot/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/export.js)_
172+
_See code: [src/commands/autopilot/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/update.js)_
150173

151174
## `twilio autopilot:fields:create`
152175

@@ -277,130 +300,6 @@ OPTIONS
277300

278301
_See code: [src/commands/autopilot/fieldvalues/upload.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/fieldvalues/upload.js)_
279302

280-
## `twilio autopilot:import [TYPE]`
281-
282-
Import a DialogFlow Agent/Alexa Interaction Model
283-
284-
```
285-
USAGE
286-
$ twilio autopilot:import [TYPE]
287-
288-
ARGUMENTS
289-
TYPE (dialogflow|alexa) [default: dialogflow] Type of import DialogFlow/Alexa
290-
291-
OPTIONS
292-
-a, --dfagent=dfagent Dialogflow Agent Name
293-
-b, --dfbackup=dfbackup Dialogflow Agent Backup Zip File Local Path
294-
-m, --model=model Alexa Interaction Model File Path
295-
-p, --profile=profile Shorthand identifier for your profile.
296-
297-
-r, --redirectURL=redirectURL [default: https://inquisitive-stretch-2083.twil.io/generic] Alexa Back-End Hanlder URL
298-
to send back the response
299-
300-
DESCRIPTION
301-
-> twilio autopilot:import dialogflow --dfbackup <dialogflow-backup-zip-file> --dfagent <dialogflow-agent-name>
302-
-> twilio autopilot:import alexa --model <alexa-interaction-model-file> [--redirectURL <alexa-back-end-hanlder-url>]
303-
```
304-
305-
_See code: [src/commands/autopilot/import.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/import.js)_
306-
307-
## `twilio autopilot:init`
308-
309-
Init autopilot bot template
310-
311-
```
312-
USAGE
313-
$ twilio autopilot:init
314-
315-
OPTIONS
316-
-n, --bot-name=bot-name create new bot project with bot name
317-
-p, --profile=profile Shorthand identifier for your profile.
318-
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise
319-
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise
320-
```
321-
322-
_See code: [src/commands/autopilot/init.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/init.js)_
323-
324-
## `twilio autopilot:list`
325-
326-
List all autopilot assistant
327-
328-
```
329-
USAGE
330-
$ twilio autopilot:list
331-
332-
OPTIONS
333-
-p, --profile=profile Shorthand identifier for your profile.
334-
--properties=properties [default: sid, uniqueName, friendlyName] The Autopilot Assistant List
335-
```
336-
337-
_See code: [src/commands/autopilot/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/list.js)_
338-
339-
## `twilio autopilot:modelbuilds:create`
340-
341-
Create Model Builds
342-
343-
```
344-
USAGE
345-
$ twilio autopilot:modelbuilds:create
346-
347-
OPTIONS
348-
-p, --profile=profile Shorthand identifier for your profile.
349-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
350-
-u, --callbackURL=callbackURL URL to get notified of model build status
351-
```
352-
353-
_See code: [src/commands/autopilot/modelbuilds/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/modelbuilds/create.js)_
354-
355-
## `twilio autopilot:queries:export`
356-
357-
Export queries of an assistant
358-
359-
```
360-
USAGE
361-
$ twilio autopilot:queries:export
362-
363-
OPTIONS
364-
-p, --profile=profile Shorthand identifier for your profile.
365-
-q, --quantity=quantity (required) number of queries to retrieve
366-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
367-
```
368-
369-
_See code: [src/commands/autopilot/queries/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/queries/export.js)_
370-
371-
## `twilio autopilot:samples:upload`
372-
373-
Upload task samples
374-
375-
```
376-
USAGE
377-
$ twilio autopilot:samples:upload
378-
379-
OPTIONS
380-
-p, --profile=profile Shorthand identifier for your profile.
381-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
382-
--file-name=file-name (required) a CSV file of samples
383-
--task-sid=task-sid task sid
384-
```
385-
386-
_See code: [src/commands/autopilot/samples/upload.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/samples/upload.js)_
387-
388-
## `twilio autopilot:simulate`
389-
390-
Simulate an assistant
391-
392-
```
393-
USAGE
394-
$ twilio autopilot:simulate
395-
396-
OPTIONS
397-
-p, --profile=profile Shorthand identifier for your profile.
398-
-s, --assistant-sid=assistant-sid (required) assistant sid
399-
-t, --text=text (required) User text input
400-
```
401-
402-
_See code: [src/commands/autopilot/simulate.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/simulate.js)_
403-
404303
## `twilio autopilot:tasks:create`
405304

406305
Create a Task of an assistant
@@ -468,21 +367,49 @@ OPTIONS
468367

469368
_See code: [src/commands/autopilot/tasks/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/tasks/update.js)_
470369

471-
## `twilio autopilot:update`
370+
## `twilio autopilot:samples:upload`
472371

473-
Update an assistant
372+
Upload task samples
474373

475374
```
476375
USAGE
477-
$ twilio autopilot:update
376+
$ twilio autopilot:samples:upload
478377
479378
OPTIONS
480-
-p, --profile=profile Shorthand identifier for your profile.
481-
-s, --schema=schema (required) schema path
482-
--unique-name=unique-name assistant unique name
379+
-p, --profile=profile Shorthand identifier for your profile.
380+
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
381+
--file-name=file-name (required) a CSV file of samples
382+
--task-sid=task-sid task sid
483383
```
484384

485-
_See code: [src/commands/autopilot/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/update.js)_
385+
_See code: [src/commands/autopilot/samples/upload.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/samples/upload.js)_
386+
387+
## `twilio autopilot:import [TYPE]`
388+
389+
Import a DialogFlow Agent/Alexa Interaction Model
390+
391+
```
392+
USAGE
393+
$ twilio autopilot:import [TYPE]
394+
395+
ARGUMENTS
396+
TYPE (dialogflow|alexa) [default: dialogflow] Type of import DialogFlow/Alexa
397+
398+
OPTIONS
399+
-a, --dfagent=dfagent Dialogflow Agent Name
400+
-b, --dfbackup=dfbackup Dialogflow Agent Backup Zip File Local Path
401+
-m, --model=model Alexa Interaction Model File Path
402+
-p, --profile=profile Shorthand identifier for your profile.
403+
404+
-r, --redirectURL=redirectURL [default: https://inquisitive-stretch-2083.twil.io/generic] Alexa Back-End Hanlder URL
405+
to send back the response
406+
407+
DESCRIPTION
408+
-> twilio autopilot:import dialogflow --dfbackup <dialogflow-backup-zip-file> --dfagent <dialogflow-agent-name>
409+
-> twilio autopilot:import alexa --model <alexa-interaction-model-file> [--redirectURL <alexa-back-end-hanlder-url>]
410+
```
411+
412+
_See code: [src/commands/autopilot/import.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/import.js)_
486413

487414
## `twilio autopilot:webhooks:create`
488415

@@ -557,6 +484,54 @@ OPTIONS
557484

558485
_See code: [src/commands/autopilot/webhooks/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/webhooks/update.js)_
559486

487+
## `twilio autopilot:modelbuilds:create`
488+
489+
Create Model Builds
490+
491+
```
492+
USAGE
493+
$ twilio autopilot:modelbuilds:create
494+
495+
OPTIONS
496+
-p, --profile=profile Shorthand identifier for your profile.
497+
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
498+
-u, --callbackURL=callbackURL URL to get notified of model build status
499+
```
500+
501+
_See code: [src/commands/autopilot/modelbuilds/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/modelbuilds/create.js)_
502+
503+
## `twilio autopilot:simulate`
504+
505+
Simulate an assistant
506+
507+
```
508+
USAGE
509+
$ twilio autopilot:simulate
510+
511+
OPTIONS
512+
-p, --profile=profile Shorthand identifier for your profile.
513+
-s, --assistant-sid=assistant-sid (required) assistant sid
514+
-t, --text=text (required) User text input
515+
```
516+
517+
_See code: [src/commands/autopilot/simulate.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/simulate.js)_
518+
519+
## `twilio autopilot:queries:export`
520+
521+
Export queries of an assistant
522+
523+
```
524+
USAGE
525+
$ twilio autopilot:queries:export
526+
527+
OPTIONS
528+
-p, --profile=profile Shorthand identifier for your profile.
529+
-q, --quantity=quantity (required) number of queries to retrieve
530+
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
531+
```
532+
533+
_See code: [src/commands/autopilot/queries/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.18/src/commands/autopilot/queries/export.js)_
534+
560535
## `twilio help [COMMAND]`
561536

562537
display help for twilio

0 commit comments

Comments
 (0)