Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit 0c22144

Browse files
authored
Merge pull request #160 from microsoft/emilio/luis
Adding plugin-plugins to main cli
2 parents 6e3e140 + 8eb4a74 commit 0c22144

File tree

11 files changed

+301
-2633
lines changed

11 files changed

+301
-2633
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ typings/
6868
#package-lock.json
6969
package-lock.json
7070

71+
#tsconfig.tsbuildinfo
72+
tsconfig.tsbuildinfo
73+
7174
#vscode files
7275
.vscode
7376
packages/dialog/test/commands/dialog/projects/obj/Debug/netcoreapp2.1/LUISGen.csproj.CoreCompileInputs.cache

packages/chatdown/README.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
bf-chatdown
1+
@microsoft/bf-chatdown
22
========
33

44
Tool for parsing chat files and outputting replayable activities
@@ -8,23 +8,6 @@ Tool for parsing chat files and outputting replayable activities
88
[![Downloads/week](https://img.shields.io/npm/dw/chatdown.svg)](https://www.npmjs.com/package/@microsoft/bf-chatdown)
99
[![License](https://img.shields.io/npm/l/chatdown.svg)](https://github.com/microsoft/botframework-cli/blob/master/packages/chatdown/package.json)
1010

11-
<!-- toc -->
12-
* [Usage](#usage)
13-
* [Commands](#commands)
14-
<!-- tocstop -->
15-
# Usage
16-
<!-- usage -->
17-
```sh-session
18-
$ bf COMMAND
19-
running command...
20-
$ bf (-v|--version|version)
21-
@microsoft/bf-chatdown/0.0.0 darwin-x64 node-v12.1.0
22-
$ bf --help [COMMAND]
23-
USAGE
24-
$ bf COMMAND
25-
...
26-
```
27-
<!-- usagestop -->
2811
# Commands
2912
<!-- commands -->
3013
* [`bf chatdown`](#bf-chatdown)

packages/cli/README.md

Lines changed: 226 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ botframework-cli
88
[![Downloads/week](https://img.shields.io/npm/dw/botframework-cli.svg)](https://www.npmjs.com/package/@microsoft/botframework-cli)
99
[![License](https://img.shields.io/npm/l/botframework-cli.svg)](https://github.com/microsoft/botframework-cli/blob/master/packages/cli/package.json)
1010

11-
<!-- toc -->
12-
* [Usage](#usage)
13-
* [Commands](#commands)
14-
<!-- tocstop -->
1511
# Usage
1612
<!-- usage -->
1713
```sh-session
@@ -37,7 +33,15 @@ USAGE
3733
* [`bf config:show:qnamaker`](#bf-configshowqnamaker)
3834
* [`bf config:show:telemetry`](#bf-configshowtelemetry)
3935
* [`bf help [COMMAND]`](#bf-help-command)
36+
* [`bf luis:convert`](#bf-luisconvert)
37+
* [`bf luis:translate`](#bf-luistranslate)
38+
* [`bf plugins`](#bf-plugins)
39+
* [`bf plugins:install PLUGIN...`](#bf-pluginsinstall-plugin)
40+
* [`bf plugins:link PLUGIN`](#bf-pluginslink-plugin)
41+
* [`bf plugins:uninstall PLUGIN...`](#bf-pluginsuninstall-plugin)
42+
* [`bf plugins:update`](#bf-pluginsupdate)
4043
* [`bf qnamaker`](#bf-qnamaker)
44+
* [`bf qnamaker:convert`](#bf-qnamakerconvert)
4145
* [`bf qnamaker:create:kb`](#bf-qnamakercreatekb)
4246
* [`bf qnamaker:delete:kb`](#bf-qnamakerdeletekb)
4347
* [`bf qnamaker:export:kb`](#bf-qnamakerexportkb)
@@ -57,6 +61,7 @@ USAGE
5761
* [`bf qnamaker:replace:alterations`](#bf-qnamakerreplacealterations)
5862
* [`bf qnamaker:replace:kb`](#bf-qnamakerreplacekb)
5963
* [`bf qnamaker:train`](#bf-qnamakertrain)
64+
* [`bf qnamaker:translate`](#bf-qnamakertranslate)
6065
* [`bf qnamaker:update:endpointsettings`](#bf-qnamakerupdateendpointsettings)
6166
* [`bf qnamaker:update:kb`](#bf-qnamakerupdatekb)
6267

@@ -89,7 +94,7 @@ OPTIONS
8994
files to be processed all at once, ex. ./**/*.chat. If flag is omitted, stdin will be used. If an
9095
output directory is not present (-o), it will default the output to the current working directory.
9196
92-
-o, --out=out Path to the directory where the output of the multiple chat file processing (-f) will be placed.
97+
-o, --out=out Path to the directory where the output of the multiple chat file processing (-o) will be placed.
9398
9499
-p, --prefix Prefix stdout with package name.
95100
@@ -210,6 +215,167 @@ OPTIONS
210215

211216
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
212217

218+
## `bf luis:convert`
219+
220+
Convert .lu file(s) to a LUIS application JSON model or vice versa
221+
222+
```
223+
USAGE
224+
$ bf luis:convert
225+
226+
OPTIONS
227+
--culture=culture Lang code for the LUIS application
228+
--description=description Text describing the LUIS applicaion
229+
--in=in (required) Source .lu file(s) or LUIS application JSON model
230+
--log Enables log messages
231+
--name=name Name of the LUIS application
232+
--out=out Output file or folder name. If not specified stdout will be used as output
233+
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
234+
--schemaversion=schemaversion Schema version of the LUIS application
235+
--sort When set, intent, utterances, entities are alphabetically sorted in .lu files
236+
--versionid=versionid Version ID of the LUIS application
237+
```
238+
239+
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/convert.ts)_
240+
241+
## `bf luis:translate`
242+
243+
Translate given LUIS application JSON model or lu file(s)
244+
245+
```
246+
USAGE
247+
$ bf luis:translate
248+
249+
OPTIONS
250+
--in=in (required) Source .lu file(s) or LUIS application JSON model
251+
--out=out Output folder name. If not specified stdout will be used as output
252+
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
253+
--srclang=srclang Source lang code. Auto detect if missing.
254+
--tgtlang=tgtlang (required) Comma separated list of target languages.
255+
--translate_comments=translate_comments When set, machine translate comments found in .lu or .qna file
256+
--translate_link_text=translate_link_text When set, machine translate link description in .lu or .qna file
257+
--translatekey=translatekey (required) Machine translation endpoint key.
258+
```
259+
260+
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/translate.ts)_
261+
262+
## `bf plugins`
263+
264+
list installed plugins
265+
266+
```
267+
USAGE
268+
$ bf plugins
269+
270+
OPTIONS
271+
--core show core plugins
272+
273+
EXAMPLE
274+
$ bf plugins
275+
```
276+
277+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/index.ts)_
278+
279+
## `bf plugins:install PLUGIN...`
280+
281+
installs a plugin into the CLI
282+
283+
```
284+
USAGE
285+
$ bf plugins:install PLUGIN...
286+
287+
ARGUMENTS
288+
PLUGIN plugin to install
289+
290+
OPTIONS
291+
-f, --force yarn install with force flag
292+
-h, --help show CLI help
293+
-v, --verbose
294+
295+
DESCRIPTION
296+
Can be installed from npm or a git url.
297+
298+
Installation of a user-installed plugin will override a core plugin.
299+
300+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
301+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
302+
the CLI without the need to patch and update the whole CLI.
303+
304+
ALIASES
305+
$ bf plugins:add
306+
307+
EXAMPLES
308+
$ bf plugins:install myplugin
309+
$ bf plugins:install https://github.com/someuser/someplugin
310+
$ bf plugins:install someuser/someplugin
311+
```
312+
313+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/install.ts)_
314+
315+
## `bf plugins:link PLUGIN`
316+
317+
links a plugin into the CLI for development
318+
319+
```
320+
USAGE
321+
$ bf plugins:link PLUGIN
322+
323+
ARGUMENTS
324+
PATH [default: .] path to plugin
325+
326+
OPTIONS
327+
-h, --help show CLI help
328+
-v, --verbose
329+
330+
DESCRIPTION
331+
Installation of a linked plugin will override a user-installed or core plugin.
332+
333+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
334+
command will override the user-installed or core plugin implementation. This is useful for development work.
335+
336+
EXAMPLE
337+
$ bf plugins:link myplugin
338+
```
339+
340+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/link.ts)_
341+
342+
## `bf plugins:uninstall PLUGIN...`
343+
344+
removes a plugin from the CLI
345+
346+
```
347+
USAGE
348+
$ bf plugins:uninstall PLUGIN...
349+
350+
ARGUMENTS
351+
PLUGIN plugin to uninstall
352+
353+
OPTIONS
354+
-h, --help show CLI help
355+
-v, --verbose
356+
357+
ALIASES
358+
$ bf plugins:unlink
359+
$ bf plugins:remove
360+
```
361+
362+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/uninstall.ts)_
363+
364+
## `bf plugins:update`
365+
366+
update installed plugins
367+
368+
```
369+
USAGE
370+
$ bf plugins:update
371+
372+
OPTIONS
373+
-h, --help show CLI help
374+
-v, --verbose
375+
```
376+
377+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/update.ts)_
378+
213379
## `bf qnamaker`
214380

215381
QnA Maker CLI (Preview version)
@@ -224,6 +390,26 @@ OPTIONS
224390

225391
_See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/index.ts)_
226392

393+
## `bf qnamaker:convert`
394+
395+
Convert .lu file(s) to a QnA application JSON model or vice versa
396+
397+
```
398+
USAGE
399+
$ bf qnamaker:convert
400+
401+
OPTIONS
402+
--alterations Indicates if files is QnA Alterations
403+
--in=in (required) Source .qna file(s) or QnA KB JSON file
404+
--log Enables log messages
405+
--name=name Name of the QnA KB
406+
--out=out Output file or folder name. If not specified stdout will be used as output
407+
--recurse Indicates if sub-folders need to be considered to file .qna file(s)
408+
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .lu files
409+
```
410+
411+
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/convert.ts)_
412+
227413
## `bf qnamaker:create:kb`
228414

229415
Creates a new knowledgebase
@@ -239,11 +425,11 @@ OPTIONS
239425
--name=name Name of the kb you want to create. This will override the name of KB that might be
240426
present in the CreateKb DTO
241427
428+
--save Save the kbId in config.
429+
242430
--subscriptionKey=subscriptionKey Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
243431
Management section for your Qna Maker cognitive service). Overrides the
244432
subscriptionkey value present in config
245-
246-
--wait Wait for the operation to complete.
247433
```
248434

249435
_See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/create/kb.ts)_
@@ -331,7 +517,7 @@ USAGE
331517
332518
OPTIONS
333519
-h, --help qnamaker:get:kb command help
334-
--kbId=kbId (required) Knowledgebase id to get metadata.
520+
--kbId=kbId Knowledgebase id to get metadata.
335521
336522
--subscriptionKey=subscriptionKey Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
337523
Management section for your Qna Maker cognitive service). Overrides the
@@ -469,28 +655,24 @@ USAGE
469655
$ bf qnamaker:query
470656
471657
OPTIONS
472-
-h, --help qnamaker:query command help
658+
-h, --help qnamaker:query command help
473659
474-
--endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
475-
user settings page). Overrides the value present in config.
660+
--endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal user
661+
settings page). Overrides the value present in config.
476662
477-
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in
478-
config.
663+
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in
664+
config.
479665
480-
--isTest Query against the test index.
666+
--isTest Query against the test index.
481667
482-
--kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the value present in the
483-
config
668+
--kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the value present in the
669+
config
484670
485-
--question=question (required) Query to get a prediction for.
671+
--question=question (required) Query to get a prediction for.
486672
487-
--scoreThreshold=scoreThreshold Query to get a prediction for.
673+
--scoreThreshold=scoreThreshold Query to get a prediction for.
488674
489-
--subscriptionKey=subscriptionKey Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
490-
Management section for your Qna Maker cognitive service). Overrides the
491-
subscriptionkey value present in config
492-
493-
--top=top Query to get a prediction for.
675+
--top=top Query to get a prediction for.
494676
```
495677

496678
_See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/query.ts)_
@@ -596,6 +778,27 @@ OPTIONS
596778

597779
_See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/train.ts)_
598780

781+
## `bf qnamaker:translate`
782+
783+
Translate given LUIS application JSON model or lu file(s)
784+
785+
```
786+
USAGE
787+
$ bf qnamaker:translate
788+
789+
OPTIONS
790+
--in=in (required) Source .lu file(s) or LUIS application JSON model
791+
--out=out Output folder name. If not specified stdout will be used as output
792+
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
793+
--srclang=srclang Source lang code. Auto detect if missing.
794+
--tgtlang=tgtlang (required) Comma separated list of target languages.
795+
--translate_comments=translate_comments When set, machine translate comments found in .lu or .qna file
796+
--translate_link_text=translate_link_text When set, machine translate link description in .lu or .qna file
797+
--translatekey=translatekey (required) Machine translation endpoint key.
798+
```
799+
800+
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/translate.ts)_
801+
599802
## `bf qnamaker:update:endpointsettings`
600803

601804
Updates endpoint settings for an endpoint.

packages/cli/package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@
77
},
88
"bugs": "https://github.com/microsoft/botframework-cli",
99
"dependencies": {
10-
"@oclif/command": "~1.5.13",
11-
"@oclif/config": "~1.13.0",
12-
"@oclif/plugin-help": "~2.1.6",
1310
"@microsoft/bf-chatdown": "1.0.0",
1411
"@microsoft/bf-cli-config": "1.0.0",
15-
"@microsoft/bf-qnamaker": "1.0.0",
1612
"@microsoft/bf-luis": "1.0.0",
13+
"@microsoft/bf-qnamaker": "1.0.0",
14+
"@oclif/command": "~1.5.13",
15+
"@oclif/config": "~1.13.0",
16+
"@oclif/plugin-help": "~2.1.6",
17+
"@oclif/plugin-plugins": "~1.7.8",
1718
"chalk": "2.4.1",
1819
"cli-ux": "^5.3.0",
1920
"fs-extra": "^7.0.1",
@@ -59,6 +60,7 @@
5960
"bin": "bf",
6061
"plugins": [
6162
"@oclif/plugin-help",
63+
"@oclif/plugin-plugins",
6264
"@microsoft/bf-chatdown",
6365
"@microsoft/bf-cli-config",
6466
"@microsoft/bf-qnamaker",

0 commit comments

Comments
 (0)