Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
794 changes: 256 additions & 538 deletions packages/cli/README.md

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions packages/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This package is intended for Microsoft use only and should be consumed through @
# Commands
<!-- commands -->
* [`bf config`](#bf-config)
* [`bf config:remove`](#bf-configremove)
* [`bf config:set`](#bf-configset)
* [`bf config:set:luis`](#bf-configsetluis)
* [`bf config:set:qnamaker`](#bf-configsetqnamaker)
Expand All @@ -32,6 +33,21 @@ OPTIONS

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

## `bf config:remove`

Removes the specified key from the config file

```
USAGE
$ bf config:remove

OPTIONS
-h, --help config:remove help
-k, --key=key (required) Name of the key to remove
```

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

## `bf config:set`

Adds the specified key and value to the config file
Expand Down Expand Up @@ -59,6 +75,7 @@ USAGE
OPTIONS
-h, --help show CLI help
--appId=appId LUIS application Id
--armToken=armToken User`s ARM token used to validate azure accounts information)
--authoringKey=authoringKey LUIS cognitive services authoring key (aka Ocp-Apim-Subscription-Key).
--endpoint=endpoint LUIS application endpoint hostname, ex: <region>.api.cognitive.microsoft.com
--subscriptionKey=subscriptionKey LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)
Expand Down
38 changes: 19 additions & 19 deletions packages/lg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ This package is intended for Microsoft use only and should be consumed through @
# Commands
<!-- commands -->
* [`bf lg`](#bf-lg)
* [`bf lg:analyze`](#bf-lganalyze)
* [`bf lg:expand`](#bf-lgexpand)
* [`bf lg:translate`](#bf-lgtranslate)
* [`bf lg:verify`](#bf-lgverify)
* [`bf lg:analyze`](#bf-lganalyze)

## `bf lg`

Expand All @@ -33,6 +33,24 @@ OPTIONS

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

## `bf lg:analyze`

Analyze templates in .lg files to show all the places where a template is used

```
USAGE
$ bf lg:analyze

OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help lg:analyze help
-i, --in=in (required) LG File or folder that contains .lg file(s)
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-r, --recurse Consider sub-folders to find .lg file(s)
```

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

## `bf lg:expand`

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

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

## `bf lg:analyze`

Analyze templates in .lg files to show all the places where a template is used.

```
USAGE
$ bf lg:analyze

OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help lg:analyze help
-i, --in=in (required) LG File or folder that contains .lg file(s)
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-r, --recurse Consider sub-folders to find .lg file(s)
```

_See code: [src/commands/lg/verify.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_
<!-- commandsstop -->

[1]:https://aka.ms/lg-file-format
Expand Down
52 changes: 33 additions & 19 deletions packages/luis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,12 @@ USAGE
OPTIONS
-h, --help show CLI help
--accountName=accountName (required) Account name
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)

--armToken=armToken (required) The bearer authorization header to use; containing the user`s
ARM token used to validate azure accounts information
--appId=appId (required) LUIS application Id (defaults to config:set:luis --appId
{APPLICATION_ID})

--armToken=armToken (required) User`s ARM token used to validate azure accounts information
(default: config:set:luis --armToken {ARM_TOKEN})

--azureSubscriptionId=azureSubscriptionId (required) Azure Subscription Id

Expand All @@ -85,7 +87,7 @@ OPTIONS
--resourceGroup=resourceGroup (required) Resource Group

--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
config:set:luis --subscriptionKey {SUBSCRIPTION_KEY})
```

_See code: [src/commands/luis/application/assignazureaccount.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/application/assignazureaccount.ts)_
Expand Down Expand Up @@ -422,14 +424,13 @@ OPTIONS

--config=config Path to config file of mapping rules

--intentName=intentName [default: _Interruption] Interruption intent name

--log Writes out log messages to console
--[no-]inner-dialog Only do inner dialog cross train

--inner-dialog Only performs the inner dialog cross train, defalt is true, to set it as false, use --no-inner-dialog
--intentName=intentName [default: _Interruption] Interruption intent name

--intra-dialog Only performs the intra dialog cross train, defalt is true, to set it as false, use --no-intra-dialog
--[no-]intra-dialog Only do intra dialog cross train

--log Writes out log messages to console
```

_See code: [src/commands/luis/cross-train.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/cross-train.ts)_
Expand Down Expand Up @@ -596,16 +597,29 @@ USAGE
$ bf luis:translate

OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:translate help
-i, --in=in Source .lu file(s) or LUIS application JSON model
-o, --out=out Output folder name. If not specified stdout will be used as output
-r, --recurse Indicates if sub-folders need to be considered to file .lu file(s)
--srclang=srclang Source lang code. Auto detect if missing.
--tgtlang=tgtlang (required) Comma separated list of target languages.
--translate_comments When set, machine translate comments found in .lu file
--translate_link_text When set, machine translate link description in .lu file
--translatekey=translatekey (required) Machine translation endpoint key.
-f, --force If --out flag is provided with the path to an existing file, overwrites
that file

-h, --help luis:translate help

-i, --in=in Source .lu file(s) or LUIS application JSON model

-o, --out=out Output folder name. If not specified stdout will be used as output

-r, --recurse Indicates if sub-folders need to be considered to file .lu file(s)

--srclang=srclang Source lang code. Auto detect if missing.

--subscription_region=subscription_region Required request header if using a Cognitive Services Resource. Optional if
using a Translator Resource.

--tgtlang=tgtlang (required) Comma separated list of target languages.

--translate_comments When set, machine translate comments found in .lu file

--translate_link_text When set, machine translate link description in .lu file

--translatekey=translatekey (required) Machine translation endpoint key.
```

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