@microsoft/botframework-cli
botframework-cli ================
Last updated 6 days ago by botframework .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @microsoft/botframework-cli 
SYNC missed versions from official npm registry.

botframework-cli

oclif Version Downloads/week License

Usage

$ npm install -g @microsoft/botframework-cli
$ bf COMMAND
running command...
$ bf (-v|--version|version)
@microsoft/botframework-cli/4.5.4 win32-x64 node-v10.16.3
$ bf --help [COMMAND]
USAGE
  $ bf COMMAND
...
$ npm install -g @microsoft/botframework-cli
$ bf COMMAND
running command...
$ bf (-v|--version|version)
@microsoft/botframework-cli/1.0.0 darwin-x64 node-v12.1.0
$ bf --help [COMMAND]
USAGE
  $ bf COMMAND
...

Commands

bf

The config plugin allows users to configure various settings within the cli.

USAGE
  $ bf

OPTIONS
  -h, --help  show CLI help

See code: @microsoft/bf-cli-config

bf chatdown

Converts chat dialog files in <filename>.chat format into transcript file. Writes corresponding <filename>.transcript for each .chat file

USAGE
  $ bf chatdown

OPTIONS
  -c, --chat=chat              The path of the chat file to be parsed. If omitted, stdin will be used.

  -f, --folder=folder          Path to directory and/or all subdirectories containing chat files to be processed all at
                               once, ex. ./**/*.chat. If an output directory is not present (-o), it will default the
                               output to the current working directory.

  -h, --help                   Chatdown command help

  -o, --out_folder=out_folder  Path to the directory where the output of the multiple chat file processing (-f) will be
                               placed.

  -p, --prefix                 Prefix stdout with package name.

  -s, --static                 Use static timestamps when generating timestamps on activities.

EXAMPLE

     $ bf chatdown
     $ bf chatdown --chat=./path/to/file/sample.chat
     $ bf chatdown -f ./test/utils/*.sample.chat -o ./
     $ (echo user=Joe && [ConversationUpdate=MembersAdded=Joe]) | bf chatdown --static

See code: @microsoft/bf-chatdown

bf config

The config plugin allows users to configure various settings within the cli.

USAGE
  $ bf config

OPTIONS
  -h, --help  show CLI help

See code: @microsoft/bf-cli-config

bf config:get

Displays the config file

USAGE
  $ bf config:get

OPTIONS
  -h, --help  show CLI help

See code: @microsoft/bf-cli-config

bf config:qnamaker:set

Set the QnAMaker config data

USAGE
  $ bf config:qnamaker:set

OPTIONS
  --kbid=kbid                        QnAMaker kbid to be set
  --subscriptionkey=subscriptionkey  QnAMaker subscriptionkey to be set

See code: @microsoft/bf-cli-config

bf config:telemetry

The telemetry commands allow the user to enable and disable telemetry

USAGE
  $ bf config:telemetry

OPTIONS
  -h, --help  show CLI help

See code: @microsoft/bf-cli-config

bf config:telemetry:disable

Disable telemetry

USAGE
  $ bf config:telemetry:disable

OPTIONS
  -h, --help  show CLI help

See code: @microsoft/bf-cli-config

bf config:telemetry:enable

Enable Telemetry

USAGE
  $ bf config:telemetry:enable

OPTIONS
  -h, --help  show CLI help

See code: @microsoft/bf-cli-config

bf help [COMMAND]

display help for bf

USAGE
  $ bf help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

bf qnamaker

QnA Maker CLI (Preview version)

USAGE
  $ bf qnamaker

OPTIONS
  -h, --help  Display QnA Maker CLI available commnads

See code: @microsoft/bf-qnamaker

bf qnamaker:create:kb

Creates a new knowledgebase

USAGE
  $ bf qnamaker:create:kb

OPTIONS
  -h, --help                         qnamaker:create:kb command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --in=in                            (required) The CreateKbDTO object to send in the body of the request.

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --name=name                        Name of the kb you want to create.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

  --wait                             Wait for the operation to complete.

See code: @microsoft/bf-qnamaker

bf qnamaker:delete:kb

Delete a knowledgebase by id

USAGE
  $ bf qnamaker:delete:kb

OPTIONS
  -h, --help                         qnamaker:delete:kb command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --force                            Do not prompt for confirmation, force the operation

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        (required) Knowledgebase id to be deleted

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:export:kb

Export a knowledgebase to .json file

USAGE
  $ bf qnamaker:export:kb

OPTIONS
  -h, --help                         qnamaker:export:kb command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --environment=environment          (required) Specifies whether environment is Test or Prod.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        (required) Knowledgebase id to be exported.

  --legacy                           Specifies if is a legacy knowlegebase.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:get

Get resources data (Kb and OperationDetails)

USAGE
  $ bf qnamaker:get

OPTIONS
  -h, --help  Display qnamaker:get available commands

See code: @microsoft/bf-qnamaker

bf qnamaker:get:kb

Get metadata about a knowledgebase

USAGE
  $ bf qnamaker:get:kb

OPTIONS
  -h, --help                         qnamaker:get:kb command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --environment=environment          Specifies whether environment is Test or Prod.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        (required) Knowledgebase id to get metadata.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:get:operationdetails

Gets details of a specific long running operation.

USAGE
  $ bf qnamaker:get:operationdetails

OPTIONS
  -h, --help                         qnamaker:get:operationdetails command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --operationId=operationId          (required) Operation id.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:init

Initializes the .qnamakerrc file with settings.

USAGE
  $ bf qnamaker:init

OPTIONS
  -h, --help  qnamaker:init command help

See code: @microsoft/bf-qnamaker

bf qnamaker:list

List QnA MAker resources (Alterations and Endpoint Keys)

USAGE
  $ bf qnamaker:list

OPTIONS
  -h, --help  Display qnamaker:list available commands

See code: @microsoft/bf-qnamaker

bf qnamaker:list:alterations

Downloads all word alterations (synonyms) that have been automatically mined or added by the user.

USAGE
  $ bf qnamaker:list:alterations

OPTIONS
  -h, --help                         qnamaker:list:alterations command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:list:endpointkeys

List all the currently valid endpointKeys for querying your private endpoint

USAGE
  $ bf qnamaker:list:endpointkeys

OPTIONS
  -h, --help                         qnamaker:list:endpointkeys command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:list:kbs

List all of your knowledgebases

USAGE
  $ bf qnamaker:list:kbs

OPTIONS
  -h, --help                         qnamaker:list:kbs command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:publish:kb

Publish all unpublished in the knowledgebase to the prod endpoint.

USAGE
  $ bf qnamaker:publish:kb

OPTIONS
  -h, --help                         qnamaker:publish:kb command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        (required) Knowledgebase id to pubish.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:query

Query model for prediction

USAGE
  $ bf qnamaker:query

OPTIONS
  -h, --help                         qnamaker:query command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --question=question                (required) Query to get a prediction for.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:refresh:endpointkeys

Re-generates an endpoint key, in case you suspect your keys have been compromised

USAGE
  $ bf qnamaker:refresh:endpointkeys

OPTIONS
  -h, --help                         qnamaker:refresh:endpoints command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --keyType=keyType                  (required) Type of Key.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:replace

Replace QnA maker resources

USAGE
  $ bf qnamaker:replace

OPTIONS
  -h, --help  display qnamaker:replace available commands

See code: @microsoft/bf-qnamaker

bf qnamaker:replace:alterations

Replaces word alterations (synonyms) for the KB with the give records.

USAGE
  $ bf qnamaker:replace:alterations

OPTIONS
  -h, --help                         qnamaker:replace:alterations command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --in=in                            (required) The WordAlterationsDTO object to send in the body of the request

  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and
                                     the QNAMAKER_KBID environment variable.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:replace:kb

Replace a knowledgebase contents with new contents

USAGE
  $ bf qnamaker:replace:kb

OPTIONS
  -h, --help                         qnamaker:replace:kb command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --in=in                            (required) The ReplaceKbDTO object to send in the body of the request

  --kbId=kbId                        (required) Knowledgebase id.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

See code: @microsoft/bf-qnamaker

bf qnamaker:update:kb

Add or delete QnA Pairs and / or URLs to an existing knowledge base

USAGE
  $ bf qnamaker:update:kb

OPTIONS
  -h, --help                         qnamaker:update:kb command help

  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
                                     user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY
                                     environment variable.

  --hostname=hostname                Specifies the url for your private QnA service. Overrides the .qnamakerrc value and
                                     the QNAMAKER_HOSTNAME environment variable.

  --in=in                            (required) The UpdateKbOperationDTO object to send in the body of the request.

  --kbId=kbId                        (required) Knowledgebase id.

  --stdin                            Specifies qnamaker configuration is being passed via stdin. Overrides the
                                     .qnamakerrc value and the QNAMAKER_KBID environment variable.

  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.

  --wait                             Wait for the operation to complete.

See code: @microsoft/bf-qnamaker

Current Tags

  • 4.5.4                                ...           latest (6 days ago)

6 Versions

  • 4.5.4                                ...           6 days ago
  • 4.5.3                                ...           6 days ago
  • 4.5.2                                ...           24 days ago
  • 4.5.1                                ...           a month ago
  • 4.5.0                                ...           a month ago
  • 0.0.0                                ...           a month ago
Downloads
Today 0
This Week 0
This Month 45
Last Day 0
Last Week 45
Last Month 60
Dependencies (12)
Dev Dependencies (15)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |