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
2 changes: 1 addition & 1 deletion packages/chatdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ _See code: [src/commands/chatdown/convert.ts](https://github.com/microsoft/botfr
<!-- commandsstop -->

[1]:./docs/chatdown-format.md
[2]:./docs/examples
[2]:./docs/examples
12 changes: 6 additions & 6 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -963,7 +963,7 @@ _See code: [@microsoft/bf-cli-plugins](https://github.com/microsoft/botframework

## `bf plugins:install PLUGIN`

installs a plugin into the BF CLI
Installs a plugin into the BF CLI

```
USAGE
Expand All @@ -978,11 +978,11 @@ OPTIONS
-v, --verbose

DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello'
command will override the core plugin implementation. This is useful if a user needs to update core plugin
functionality in the CLI without the need to patch and update the whole CLI.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation.
This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the
whole CLI.

ALIASES
$ bf plugins:add
Expand Down
2 changes: 0 additions & 2 deletions packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
"@microsoft/bf-cli-config",
"@microsoft/bf-qnamaker",
"@microsoft/bf-luis-cli",
"@microsoft/bf-dialog",
"@microsoft/bf-cli-plugins"
],
"hooks": {
Expand Down Expand Up @@ -59,7 +58,6 @@
"@microsoft/bf-cli-config": "1.0.0",
"@microsoft/bf-luis-cli": "1.0.0",
"@microsoft/bf-qnamaker": "1.0.0",
"@microsoft/bf-dialog": "1.0.0",
"@microsoft/bf-cli-plugins": "1.0.0",
"@oclif/command": "~1.5.19",
"@oclif/config": "~1.13.3",
Expand Down
12 changes: 6 additions & 6 deletions packages/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ _See code: [src/commands/plugins/index.ts](https://github.com/microsoft/botframe

## `bf plugins:install PLUGIN`

installs a plugin into the BF CLI
Installs a plugin into the BF CLI

```
USAGE
Expand All @@ -49,11 +49,11 @@ OPTIONS
-v, --verbose

DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello'
command will override the core plugin implementation. This is useful if a user needs to update core plugin
functionality in the CLI without the need to patch and update the whole CLI.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation.
This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the
whole CLI.

ALIASES
$ bf plugins:add
Expand Down
7 changes: 3 additions & 4 deletions packages/plugins/src/commands/plugins/install.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ import Plugins from '@oclif/plugin-plugins/lib/plugins'
import cli from 'cli-ux'

export default class PluginsInstall extends Command {
static description = `installs a plugin into the BF CLI
Can be installed from npm or a git url.
static description = `Installs a plugin into the BF CLI
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.
`
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation.
This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.`

static strict = false

Expand Down
51 changes: 49 additions & 2 deletions packages/qnamaker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ This package is intended for Microsoft use only and should be consumed through @
* [`bf qnamaker:alterations`](#bf-qnamakeralterations)
* [`bf qnamaker:alterations:list`](#bf-qnamakeralterationslist)
* [`bf qnamaker:alterations:replace`](#bf-qnamakeralterationsreplace)
* [`bf qnamaker:convert`](#bf-qnamakerconvert)
* [`bf qnamaker:endpointkeys`](#bf-qnamakerendpointkeys)
* [`bf qnamaker:endpointkeys:list`](#bf-qnamakerendpointkeyslist)
* [`bf qnamaker:endpointkeys:refresh`](#bf-qnamakerendpointkeysrefresh)
Expand All @@ -38,6 +39,7 @@ This package is intended for Microsoft use only and should be consumed through @
* [`bf qnamaker:operationdetails:get`](#bf-qnamakeroperationdetailsget)
* [`bf qnamaker:query`](#bf-qnamakerquery)
* [`bf qnamaker:train`](#bf-qnamakertrain)
* [`bf qnamaker:translate`](#bf-qnamakertranslate)

## `bf qnamaker`

Expand Down Expand Up @@ -106,6 +108,28 @@ OPTIONS

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

## `bf qnamaker:convert`

Converts .qna file(s) to QnA application JSON models or vice versa.

```
USAGE
$ bf qnamaker:convert

OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help qnamaker:convert help
-i, --in=in Source .qna file(s) or QnA KB JSON file
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-r, --recurse Indicates if sub-folders need to be considered to file .qna file(s)
--alterations Indicates if files is QnA Alterations
--log Enables log messages
--name=name Name of the QnA KB
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
```

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

## `bf qnamaker:endpointkeys`

Commands to refresh and list keys
Expand Down Expand Up @@ -301,7 +325,7 @@ USAGE
OPTIONS
-h, --help qnamaker:kb:export command help
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--environment=environment (required) Specifies whether environment is Test or Prod.
--environment=environment [default: Prod] Specifies whether environment is Test or Prod.

--kbId=kbId Knowledgebase id to be exported. Overrides the knowledge base id present in the
config
Expand Down Expand Up @@ -519,8 +543,31 @@ OPTIONS
```

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

## `bf qnamaker:translate`

Translate given QnA maker application JSON model or qna file(s)

```
USAGE
$ bf qnamaker:translate

OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help qnamaker:translate help
-i, --in=in Source .qna file(s) or QnA maker 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 find .qna 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 .qna file
--translate_link_text When set, machine translate link description in .qna file
--translatekey=translatekey (required) Machine translation endpoint key.
```

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

[1]:./docs/qna-file-format.md
[2]:./docs/working-with-qna.md
[3]:./docs/translate-command.md
[3]:./docs/translate-command.md