@microsoft/bf-cli-config

@microsoft/bf-cli-config

This package is intended for Microsoft use only and should be consumed through @microsoft/botframework-cli. It is not designed to be consumed as an independent package.

Commands

• bf config
• bf config:remove
• bf config:set
• bf config:set:luis
• bf config:set:qnamaker
• bf config:set:telemetry
• bf config:show
• bf config:show:luis
• bf config:show:qnamaker
• bf config:show:telemetry

bf config

Configure various settings within the cli.

USAGE
  $ bf config

OPTIONS
  -h, --help  config help

See code: 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

bf config:set

Adds the specified key and value to the config file

USAGE
  $ bf config:set

OPTIONS
  -h, --help         config:set help
  -k, --key=key      (required) Name of the key to add or override
  -v, --value=value  (required) Value associated with the specified key

See code: src\commands\config\set.ts

bf config:set:luis

Stores default LUIS application values in global config.

USAGE
  $ bf config:set:luis

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)
  --versionId=versionId              LUIS version Id

EXAMPLE

       $ bf config:set:luis --appId {APPLICATION_ID} --authoringKey {AUTHORING_KEY} --subscriptionKey {SUBSCRIPTION_KEY} 
  --versionId {VERSION_ID} --endpoint {ENDPOINT}

See code: src\commands\config\set\luis.ts

bf config:set:qnamaker

Set the QnAMaker config data

USAGE
  $ bf config:set:qnamaker

OPTIONS
  -h, --help                         config:set:qnamaker help
  --endpointKey=endpointKey          QnAMaker endpointKey to be set
  --hostname=hostname                QnAMaker hostname to be set
  --kbId=kbId                        QnAMaker kbId to be set
  --subscriptionKey=subscriptionKey  QnAMaker subscriptionkey to be set

EXAMPLE

     {
       "qnamaker_kbId": "3bda64af-dddd-dddd-dddd-021906b093b1",
       "qnamaker_subscriptionKey": "nnnnnnnnnnnnnnnnnnnnnnnnn",
       "qnamaker_endpointKey": "6b5ecf9c-kkkk-kkkk-kkkk-761489817e5f",
       "qnamaker_hostname": "https://{qnaservice-hostname}.azurewebsites.net"
     }

See code: src\commands\config\set\qnamaker.ts

bf config:set:telemetry

Enable or disable anonymous data collection to improve the products. (Command group calls and flags usage)

USAGE
  $ bf config:set:telemetry

OPTIONS
  -d, --disable  Disable tlemetry
  -e, --enable   Enable tlemetry
  -h, --help     config:set:telemetry help

See code: src\commands\config\set\telemetry.ts

bf config:show

Displays the config file

USAGE
  $ bf config:show

OPTIONS
  -h, --help     config:show help
  -k, --key=key  Shows specific key value

See code: src\commands\config\show.ts

bf config:show:luis

Display LUIS settings

USAGE
  $ bf config:show:luis

OPTIONS
  -h, --help  config:show:luis help

See code: src\commands\config\show\luis.ts

bf config:show:qnamaker

Display QnAMaker settings

USAGE
  $ bf config:show:qnamaker

OPTIONS
  -h, --help  config:show:qnamaker help

See code: src\commands\config\show\qnamaker.ts

bf config:show:telemetry

Display telemetry settings

USAGE
  $ bf config:show:telemetry

OPTIONS
  -h, --help  config:show:telemetry help

See code: src\commands\config\show\telemetry.ts

• bf config
• bf config:remove
• bf config:set
• bf config:set:luis
• bf config:set:qnamaker
• bf config:set:telemetry
• bf config:show
• bf config:show:luis
• bf config:show:qnamaker
• bf config:show:telemetry

bf config

Configure various settings within the cli.

USAGE
  $ bf config

OPTIONS
  -h, --help  config help

See code: 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

bf config:set

Adds the specified key and value to the config file

USAGE
  $ bf config:set

OPTIONS
  -h, --help         config:set help
  -k, --key=key      (required) Name of the key to add or override
  -v, --value=value  (required) Value associated with the specified key

See code: src/commands/config/set.ts

bf config:set:luis

Stores default LUIS application values in global config.

USAGE
  $ bf config:set:luis

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)
  --versionId=versionId              LUIS version Id

EXAMPLE

       $ bf config:set:luis --appId {APPLICATION_ID} --authoringKey {AUTHORING_KEY} --subscriptionKey {SUBSCRIPTION_KEY} 
  --versionId {VERSION_ID} --endpoint {ENDPOINT}

See code: src/commands/config/set/luis.ts

bf config:set:qnamaker

Set the QnAMaker config data

USAGE
  $ bf config:set:qnamaker

OPTIONS
  -h, --help                         config:set:qnamaker help
  --endpointKey=endpointKey          QnAMaker endpointKey to be set
  --hostname=hostname                QnAMaker hostname to be set
  --kbId=kbId                        QnAMaker kbId to be set
  --subscriptionKey=subscriptionKey  QnAMaker subscriptionkey to be set

EXAMPLE

     {
       "qnamaker_kbId": "3bda64af-dddd-dddd-dddd-021906b093b1",
       "qnamaker_subscriptionKey": "nnnnnnnnnnnnnnnnnnnnnnnnn",
       "qnamaker_endpointKey": "6b5ecf9c-kkkk-kkkk-kkkk-761489817e5f",
       "qnamaker_hostname": "https://{qnaservice-hostname}.azurewebsites.net"
     }

See code: src/commands/config/set/qnamaker.ts

bf config:set:telemetry

Enable or disable anonymous data collection to improve the products. (Command group calls and flags usage)

USAGE
  $ bf config:set:telemetry

OPTIONS
  -d, --disable  Disable tlemetry
  -e, --enable   Enable tlemetry
  -h, --help     config:set:telemetry help

See code: src/commands/config/set/telemetry.ts

bf config:show

Displays the config file

USAGE
  $ bf config:show

OPTIONS
  -h, --help     config:show help
  -k, --key=key  Shows specific key value

See code: src/commands/config/show.ts

bf config:show:luis

Display LUIS settings

USAGE
  $ bf config:show:luis

OPTIONS
  -h, --help  config:show:luis help

See code: src/commands/config/show/luis.ts

bf config:show:qnamaker

Display QnAMaker settings

USAGE
  $ bf config:show:qnamaker

OPTIONS
  -h, --help  config:show:qnamaker help

See code: src/commands/config/show/qnamaker.ts

bf config:show:telemetry

Display telemetry settings

USAGE
  $ bf config:show:telemetry

OPTIONS
  -h, --help  config:show:telemetry help

See code: src/commands/config/show/telemetry.ts