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

Commit ecafb81

Browse files
authored
Updating docs (#1172)
1 parent e7d2e8f commit ecafb81

File tree

8 files changed

+542
-695
lines changed

8 files changed

+542
-695
lines changed

packages/cli/README.md

Lines changed: 256 additions & 538 deletions
Large diffs are not rendered by default.

packages/config/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This package is intended for Microsoft use only and should be consumed through @
99
# Commands
1010
<!-- commands -->
1111
* [`bf config`](#bf-config)
12+
* [`bf config:remove`](#bf-configremove)
1213
* [`bf config:set`](#bf-configset)
1314
* [`bf config:set:luis`](#bf-configsetluis)
1415
* [`bf config:set:qnamaker`](#bf-configsetqnamaker)
@@ -32,6 +33,21 @@ OPTIONS
3233

3334
_See code: [src/commands/config/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/index.ts)_
3435

36+
## `bf config:remove`
37+
38+
Removes the specified key from the config file
39+
40+
```
41+
USAGE
42+
$ bf config:remove
43+
44+
OPTIONS
45+
-h, --help config:remove help
46+
-k, --key=key (required) Name of the key to remove
47+
```
48+
49+
_See code: [src/commands/config/remove.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/remove.ts)_
50+
3551
## `bf config:set`
3652

3753
Adds the specified key and value to the config file
@@ -59,6 +75,7 @@ USAGE
5975
OPTIONS
6076
-h, --help show CLI help
6177
--appId=appId LUIS application Id
78+
--armToken=armToken User`s ARM token used to validate azure accounts information)
6279
--authoringKey=authoringKey LUIS cognitive services authoring key (aka Ocp-Apim-Subscription-Key).
6380
--endpoint=endpoint LUIS application endpoint hostname, ex: <region>.api.cognitive.microsoft.com
6481
--subscriptionKey=subscriptionKey LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)

packages/lg/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ This package is intended for Microsoft use only and should be consumed through @
1414
# Commands
1515
<!-- commands -->
1616
* [`bf lg`](#bf-lg)
17+
* [`bf lg:analyze`](#bf-lganalyze)
1718
* [`bf lg:expand`](#bf-lgexpand)
1819
* [`bf lg:translate`](#bf-lgtranslate)
1920
* [`bf lg:verify`](#bf-lgverify)
20-
* [`bf lg:analyze`](#bf-lganalyze)
2121

2222
## `bf lg`
2323

@@ -33,6 +33,24 @@ OPTIONS
3333

3434
_See code: [src/commands/lg/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/index.ts)_
3535

36+
## `bf lg:analyze`
37+
38+
Analyze templates in .lg files to show all the places where a template is used
39+
40+
```
41+
USAGE
42+
$ bf lg:analyze
43+
44+
OPTIONS
45+
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
46+
-h, --help lg:analyze help
47+
-i, --in=in (required) LG File or folder that contains .lg file(s)
48+
-o, --out=out Output file or folder name. If not specified stdout will be used as output
49+
-r, --recurse Consider sub-folders to find .lg file(s)
50+
```
51+
52+
_See code: [src/commands/lg/analyze.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_
53+
3654
## `bf lg:expand`
3755

3856
Expand one or all templates in .lg file(s). Expand an inline expression.
@@ -97,24 +115,6 @@ OPTIONS
97115
```
98116

99117
_See code: [src/commands/lg/verify.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/verify.ts)_
100-
101-
## `bf lg:analyze`
102-
103-
Analyze templates in .lg files to show all the places where a template is used.
104-
105-
```
106-
USAGE
107-
$ bf lg:analyze
108-
109-
OPTIONS
110-
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
111-
-h, --help lg:analyze help
112-
-i, --in=in (required) LG File or folder that contains .lg file(s)
113-
-o, --out=out Output file or folder name. If not specified stdout will be used as output
114-
-r, --recurse Consider sub-folders to find .lg file(s)
115-
```
116-
117-
_See code: [src/commands/lg/verify.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_
118118
<!-- commandsstop -->
119119

120120
[1]:https://aka.ms/lg-file-format

packages/luis/README.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,12 @@ USAGE
7171
OPTIONS
7272
-h, --help show CLI help
7373
--accountName=accountName (required) Account name
74-
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
7574
76-
--armToken=armToken (required) The bearer authorization header to use; containing the user`s
77-
ARM token used to validate azure accounts information
75+
--appId=appId (required) LUIS application Id (defaults to config:set:luis --appId
76+
{APPLICATION_ID})
77+
78+
--armToken=armToken (required) User`s ARM token used to validate azure accounts information
79+
(default: config:set:luis --armToken {ARM_TOKEN})
7880
7981
--azureSubscriptionId=azureSubscriptionId (required) Azure Subscription Id
8082
@@ -85,7 +87,7 @@ OPTIONS
8587
--resourceGroup=resourceGroup (required) Resource Group
8688
8789
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
88-
config:LUIS:subscriptionKey)
90+
config:set:luis --subscriptionKey {SUBSCRIPTION_KEY})
8991
```
9092

9193
_See code: [src/commands/luis/application/assignazureaccount.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/application/assignazureaccount.ts)_
@@ -422,14 +424,13 @@ OPTIONS
422424
423425
--config=config Path to config file of mapping rules
424426
425-
--intentName=intentName [default: _Interruption] Interruption intent name
426-
427-
--log Writes out log messages to console
427+
--[no-]inner-dialog Only do inner dialog cross train
428428
429-
--inner-dialog Only performs the inner dialog cross train, defalt is true, to set it as false, use --no-inner-dialog
429+
--intentName=intentName [default: _Interruption] Interruption intent name
430430
431-
--intra-dialog Only performs the intra dialog cross train, defalt is true, to set it as false, use --no-intra-dialog
431+
--[no-]intra-dialog Only do intra dialog cross train
432432
433+
--log Writes out log messages to console
433434
```
434435

435436
_See code: [src/commands/luis/cross-train.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/cross-train.ts)_
@@ -596,16 +597,29 @@ USAGE
596597
$ bf luis:translate
597598
598599
OPTIONS
599-
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
600-
-h, --help luis:translate help
601-
-i, --in=in Source .lu file(s) or LUIS application JSON model
602-
-o, --out=out Output folder name. If not specified stdout will be used as output
603-
-r, --recurse Indicates if sub-folders need to be considered to file .lu file(s)
604-
--srclang=srclang Source lang code. Auto detect if missing.
605-
--tgtlang=tgtlang (required) Comma separated list of target languages.
606-
--translate_comments When set, machine translate comments found in .lu file
607-
--translate_link_text When set, machine translate link description in .lu file
608-
--translatekey=translatekey (required) Machine translation endpoint key.
600+
-f, --force If --out flag is provided with the path to an existing file, overwrites
601+
that file
602+
603+
-h, --help luis:translate help
604+
605+
-i, --in=in Source .lu file(s) or LUIS application JSON model
606+
607+
-o, --out=out Output folder name. If not specified stdout will be used as output
608+
609+
-r, --recurse Indicates if sub-folders need to be considered to file .lu file(s)
610+
611+
--srclang=srclang Source lang code. Auto detect if missing.
612+
613+
--subscription_region=subscription_region Required request header if using a Cognitive Services Resource. Optional if
614+
using a Translator Resource.
615+
616+
--tgtlang=tgtlang (required) Comma separated list of target languages.
617+
618+
--translate_comments When set, machine translate comments found in .lu file
619+
620+
--translate_link_text When set, machine translate link description in .lu file
621+
622+
--translatekey=translatekey (required) Machine translation endpoint key.
609623
```
610624

611625
_See code: [src/commands/luis/translate.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/translate.ts)_

0 commit comments

Comments
 (0)