Skip to content

Commit f76ca75

Browse files
add init and deploy commands to the readme
1 parent f3e97c8 commit f76ca75

File tree

3 files changed

+106
-26
lines changed

3 files changed

+106
-26
lines changed

README.md

Lines changed: 65 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ _Assistants_
5252
* [`twilio autopilot:export`](#twilio-autopilotexport)
5353
* [`twilio autopilot:list`](#twilio-autopilotlist)
5454
* [`twilio autopilot:update`](#twilio-autopilotupdate)
55+
* [`twilio autopilot:init`](#twilio-autopilotinit)
56+
* [`twilio autopilot:deploy`](#twilio-autopilotdeploy)
5557

5658
_Fields and Field Types_
5759

@@ -106,7 +108,7 @@ OPTIONS
106108
-s, --schema=schema (required) [default: templates] path to schema file
107109
```
108110

109-
_See code: [src/commands/autopilot/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/create.js)_
111+
_See code: [src/commands/autopilot/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/create.js)_
110112

111113
## `twilio autopilot:delete`
112114

@@ -122,7 +124,7 @@ OPTIONS
122124
--unique-name=unique-name assistant unique name
123125
```
124126

125-
_See code: [src/commands/autopilot/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/delete.js)_
127+
_See code: [src/commands/autopilot/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/delete.js)_
126128

127129
## `twilio autopilot:export`
128130

@@ -138,7 +140,7 @@ OPTIONS
138140
--unique-name=unique-name assistant unique name
139141
```
140142

141-
_See code: [src/commands/autopilot/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/export.js)_
143+
_See code: [src/commands/autopilot/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/export.js)_
142144

143145
## `twilio autopilot:list`
144146

@@ -154,7 +156,7 @@ OPTIONS
154156
https://www.twilio.com/docs/autopilot/api/assistant#assistant-properties
155157
```
156158

157-
_See code: [src/commands/autopilot/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/list.js)_
159+
_See code: [src/commands/autopilot/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/list.js)_
158160

159161
## `twilio autopilot:update`
160162

@@ -170,7 +172,45 @@ OPTIONS
170172
--unique-name=unique-name assistant unique name
171173
```
172174

173-
_See code: [src/commands/autopilot/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/update.js)_
175+
_See code: [src/commands/autopilot/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/update.js)_
176+
177+
## `twilio autopilot:init`
178+
179+
Create new bot project based on chosen template
180+
181+
```
182+
USAGE
183+
$ twilio autopilot:init
184+
185+
OPTIONS
186+
-n, --bot-name=bot-name create new bot project with bot name
187+
-p, --profile=profile Shorthand identifier for your profile.
188+
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise
189+
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise
190+
--url=url the url to the template list or the git repo
191+
```
192+
193+
_See code: [src/commands/autopilot/init.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/init.js)_
194+
195+
## `twilio autopilot:deploy`
196+
197+
Deploy bot project
198+
199+
```
200+
USAGE
201+
$ twilio autopilot:deploy
202+
203+
OPTIONS
204+
-c, --config=config [default: .twilio-functions] Location of the config file. Absolute path or relative to current working directory (cwd).
205+
-l, --logLevel=logLevel [default: info] Level of logging messages.
206+
-p, --profile=profile Shorthand identifier for your profile.
207+
-t, --target=all|function|model [default: all] deploy function, model or all of them. Options can only be "all", "function" or "model".
208+
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise.
209+
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise.
210+
--override-existing-project Deploys Serverless project to existing service if a naming conflict has been found.
211+
```
212+
213+
_See code: [src/commands/autopilot/deploy.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/deploy.js)_
174214

175215
## `twilio autopilot:fields:create`
176216

@@ -193,7 +233,7 @@ OPTIONS
193233
--unique-name=unique-name (required) field unique name
194234
```
195235

196-
_See code: [src/commands/autopilot/fields/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/fields/create.js)_
236+
_See code: [src/commands/autopilot/fields/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/fields/create.js)_
197237

198238
## `twilio autopilot:fields:delete`
199239

@@ -212,7 +252,7 @@ OPTIONS
212252
--task-sid=task-sid task sid
213253
```
214254

215-
_See code: [src/commands/autopilot/fields/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/fields/delete.js)_
255+
_See code: [src/commands/autopilot/fields/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/fields/delete.js)_
216256

217257
## `twilio autopilot:fields:list`
218258

@@ -230,7 +270,7 @@ OPTIONS
230270
--task-sid=task-sid task sid
231271
```
232272

233-
_See code: [src/commands/autopilot/fields/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/fields/list.js)_
273+
_See code: [src/commands/autopilot/fields/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/fields/list.js)_
234274

235275
## `twilio autopilot:fieldtypes:create`
236276

@@ -247,7 +287,7 @@ OPTIONS
247287
--unique-name=unique-name (required) unique name for the field type
248288
```
249289

250-
_See code: [src/commands/autopilot/fieldtypes/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/fieldtypes/create.js)_
290+
_See code: [src/commands/autopilot/fieldtypes/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/fieldtypes/create.js)_
251291

252292
## `twilio autopilot:fieldtypes:list`
253293

@@ -264,7 +304,7 @@ OPTIONS
264304
https://www.twilio.com/docs/autopilot/api/field-type#fieldtype-properties
265305
```
266306

267-
_See code: [src/commands/autopilot/fieldtypes/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/fieldtypes/list.js)_
307+
_See code: [src/commands/autopilot/fieldtypes/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/fieldtypes/list.js)_
268308

269309
## `twilio autopilot:fieldtypes:update`
270310

@@ -282,7 +322,7 @@ OPTIONS
282322
--unique-name=unique-name field unique name
283323
```
284324

285-
_See code: [src/commands/autopilot/fieldtypes/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/fieldtypes/update.js)_
325+
_See code: [src/commands/autopilot/fieldtypes/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/fieldtypes/update.js)_
286326

287327
## `twilio autopilot:fieldvalues:upload`
288328

@@ -299,7 +339,7 @@ OPTIONS
299339
--file-name=file-name (required) a CSV file of field values (one on each row with synonyms in columns)
300340
```
301341

302-
_See code: [src/commands/autopilot/fieldvalues/upload.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/fieldvalues/upload.js)_
342+
_See code: [src/commands/autopilot/fieldvalues/upload.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/fieldvalues/upload.js)_
303343

304344
## `twilio autopilot:tasks:create`
305345

@@ -316,7 +356,7 @@ OPTIONS
316356
--unique-name=unique-name (required) unique name for task
317357
```
318358

319-
_See code: [src/commands/autopilot/tasks/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/tasks/create.js)_
359+
_See code: [src/commands/autopilot/tasks/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/tasks/create.js)_
320360

321361
## `twilio autopilot:tasks:delete`
322362

@@ -332,7 +372,7 @@ OPTIONS
332372
--task-sid=task-sid task sid
333373
```
334374

335-
_See code: [src/commands/autopilot/tasks/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/tasks/delete.js)_
375+
_See code: [src/commands/autopilot/tasks/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/tasks/delete.js)_
336376

337377
## `twilio autopilot:tasks:list`
338378

@@ -349,7 +389,7 @@ OPTIONS
349389
https://www.twilio.com/docs/autopilot/api/task#task-properties
350390
```
351391

352-
_See code: [src/commands/autopilot/tasks/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/tasks/list.js)_
392+
_See code: [src/commands/autopilot/tasks/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/tasks/list.js)_
353393

354394
## `twilio autopilot:tasks:update`
355395

@@ -367,7 +407,7 @@ OPTIONS
367407
--unique-name=unique-name task unique name to update
368408
```
369409

370-
_See code: [src/commands/autopilot/tasks/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/tasks/update.js)_
410+
_See code: [src/commands/autopilot/tasks/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/tasks/update.js)_
371411

372412
## `twilio autopilot:samples:upload`
373413

@@ -384,7 +424,7 @@ OPTIONS
384424
--task-sid=task-sid task sid
385425
```
386426

387-
_See code: [src/commands/autopilot/samples/upload.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/samples/upload.js)_
427+
_See code: [src/commands/autopilot/samples/upload.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/samples/upload.js)_
388428

389429
## `twilio autopilot:import [TYPE]`
390430

@@ -411,7 +451,7 @@ DESCRIPTION
411451
-> twilio autopilot:import alexa --model <alexa-interaction-model-file> [--redirectURL <alexa-back-end-hanlder-url>]
412452
```
413453

414-
_See code: [src/commands/autopilot/import.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/import.js)_
454+
_See code: [src/commands/autopilot/import.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/import.js)_
415455

416456
## `twilio autopilot:webhooks:create`
417457

@@ -430,7 +470,7 @@ OPTIONS
430470
-w, --webhook-unique-name=webhook-unique-name (required) unique name for webhook
431471
```
432472

433-
_See code: [src/commands/autopilot/webhooks/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/webhooks/create.js)_
473+
_See code: [src/commands/autopilot/webhooks/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/webhooks/create.js)_
434474

435475
## `twilio autopilot:webhooks:delete`
436476

@@ -446,7 +486,7 @@ OPTIONS
446486
--webhook-sid=webhook-sid SID of the webhook to delete
447487
```
448488

449-
_See code: [src/commands/autopilot/webhooks/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/webhooks/delete.js)_
489+
_See code: [src/commands/autopilot/webhooks/delete.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/webhooks/delete.js)_
450490

451491
## `twilio autopilot:webhooks:list`
452492

@@ -466,7 +506,7 @@ OPTIONS
466506
467507
```
468508

469-
_See code: [src/commands/autopilot/webhooks/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/webhooks/list.js)_
509+
_See code: [src/commands/autopilot/webhooks/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/webhooks/list.js)_
470510

471511
## `twilio autopilot:webhooks:update`
472512

@@ -486,7 +526,7 @@ OPTIONS
486526
--webhook-sid=webhook-sid SID of the webhook to update
487527
```
488528

489-
_See code: [src/commands/autopilot/webhooks/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/webhooks/update.js)_
529+
_See code: [src/commands/autopilot/webhooks/update.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/webhooks/update.js)_
490530

491531
## `twilio autopilot:modelbuilds:create`
492532

@@ -502,7 +542,7 @@ OPTIONS
502542
-u, --callbackURL=callbackURL URL to get notified of model build status
503543
```
504544

505-
_See code: [src/commands/autopilot/modelbuilds/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/modelbuilds/create.js)_
545+
_See code: [src/commands/autopilot/modelbuilds/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/modelbuilds/create.js)_
506546

507547
## `twilio autopilot:simulate`
508548

@@ -518,7 +558,7 @@ OPTIONS
518558
-t, --text=text (required) User text input
519559
```
520560

521-
_See code: [src/commands/autopilot/simulate.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/simulate.js)_
561+
_See code: [src/commands/autopilot/simulate.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/simulate.js)_
522562

523563
## `twilio autopilot:queries:export`
524564

@@ -534,7 +574,7 @@ OPTIONS
534574
-s, --assistant-sid=assistant-sid (required) assistant sid
535575
```
536576

537-
_See code: [src/commands/autopilot/queries/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0/src/commands/autopilot/queries/export.js)_
577+
_See code: [src/commands/autopilot/queries/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.1/src/commands/autopilot/queries/export.js)_
538578

539579
## `twilio help [COMMAND]`
540580

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@dabblelab/plugin-autopilot",
33
"description": "Create, Update, Delete, List, Simulate, Import and Export Twilio Autopilot Assistant",
4-
"version": "1.0.0",
4+
"version": "1.0.1",
55
"author": "Steve Tingiris",
66
"bugs": "https://github.com/tingiris/twilio-cli-autopilot-plugin/issues",
77
"dependencies": {

readmeText.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ _Assistants_
5252
* [`twilio autopilot:export`](#twilio-autopilotexport)
5353
* [`twilio autopilot:list`](#twilio-autopilotlist)
5454
* [`twilio autopilot:update`](#twilio-autopilotupdate)
55+
* [`twilio autopilot:init`](#twilio-autopilotinit)
56+
* [`twilio autopilot:deploy`](#twilio-autopilotdeploy)
5557

5658
_Fields and Field Types_
5759

@@ -172,6 +174,44 @@ OPTIONS
172174

173175
_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)_
174176

177+
## `twilio autopilot:init`
178+
179+
Create new bot project based on chosen template
180+
181+
```
182+
USAGE
183+
$ twilio autopilot:init
184+
185+
OPTIONS
186+
-n, --bot-name=bot-name create new bot project with bot name
187+
-p, --profile=profile Shorthand identifier for your profile.
188+
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise
189+
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise
190+
--url=url the url to the template list or the git repo
191+
```
192+
193+
_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)_
194+
195+
## `twilio autopilot:deploy`
196+
197+
Deploy bot project
198+
199+
```
200+
USAGE
201+
$ twilio autopilot:deploy
202+
203+
OPTIONS
204+
-c, --config=config [default: .twilio-functions] Location of the config file. Absolute path or relative to current working directory (cwd).
205+
-l, --logLevel=logLevel [default: info] Level of logging messages.
206+
-p, --profile=profile Shorthand identifier for your profile.
207+
-t, --target=all|function|model [default: all] deploy function, model or all of them. Options can only be "all", "function" or "model".
208+
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise.
209+
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise.
210+
--override-existing-project Deploys Serverless project to existing service if a naming conflict has been found.
211+
```
212+
213+
_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)_
214+
175215
## `twilio autopilot:fields:create`
176216

177217
Create field of a task

0 commit comments

Comments
 (0)