# @microsoft/bf-cli-config

> @microsoft/bf-cli-config ========================

Latest version **4.15.0** (published 2021-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @microsoft/bf-cli-config
pnpm add @microsoft/bf-cli-config
yarn add @microsoft/bf-cli-config
bun add @microsoft/bf-cli-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.15.0 |
| Published | 2021-11-16 |
| First published | 2019-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 7 |
| Unpacked size | 46.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 175 |
| Author | Microsoft |
| Maintainers | botframework, joshgummersall, sgellock, cmullins, cwhitten, peterinnesmsft, microsoft1es |
| Keywords | oclif-plugin |

## Links

- npm: https://www.npmjs.com/package/@microsoft/bf-cli-config
- Repository: https://github.com/microsoft/botframework-cli/tree/master/packages/config
- Homepage: https://github.com/microsoft/botframework-cli
- Issues: https://github.com/microsoft/botframework-cli
- npm.io page: https://npm.io/package/@microsoft/bf-cli-config

## Dependencies (7)

- [tslib](https://npm.io/package/tslib.md) ^2.0.3
- [cli-ux](https://npm.io/package/cli-ux.md) ^5.3.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [@oclif/config](https://npm.io/package/@oclif/config.md) ~1.13.3
- [@oclif/errors](https://npm.io/package/@oclif/errors.md) ~1.2.2
- [@oclif/command](https://npm.io/package/@oclif/command.md) ~1.5.19
- [@microsoft/bf-cli-command](https://npm.io/package/@microsoft/bf-cli-command.md) 4.15.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 4.15.0 (latest) — 2021-11-16
- 4.16.0-dev.20231122.4561d55 (next) — 2023-11-22
- 4.16.0-dev.20221114.64f07e4 — 2022-11-14
- 4.16.0-dev.20221111.64f07e4 — 2022-11-11
- 4.16.0-dev.20221107.64f07e4 — 2022-11-07
- 4.16.0-dev.20220725.a0ab7ca — 2022-07-25
- 4.16.0-dev.20220526.695cee5 — 2022-05-26
- 4.16.0-dev.20220525.147c370 — 2022-05-25
- 4.16.0-dev.20220228.5bb413a — 2022-02-28
- 4.16.0-dev.20220120.e933dfc — 2022-01-20
- 4.16.0-dev.20220110.b4d497d — 2022-01-10
- 4.16.0-dev.20220106.c44b989 — 2022-01-06
- 4.16.0-dev.20220105.c44b989 — 2022-01-06
- 4.16.0-dev.20220105.380511c — 2022-01-05
- 4.16.0-dev.20220104.33b5e0a — 2022-01-04
- … 187 more at https://npm.io/package/@microsoft/bf-cli-config/versions

## README

@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.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@microsoft/bf-cli-config)](https://www.npmjs.com/package/@microsoft/bf-cli-config)

# 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)
* [`bf config:set:telemetry`](#bf-configsettelemetry)
* [`bf config:show`](#bf-configshow)
* [`bf config:show:luis`](#bf-configshowluis)
* [`bf config:show:qnamaker`](#bf-configshowqnamaker)
* [`bf config:show:telemetry`](#bf-configshowtelemetry)

## `bf config`

Configure various settings within the cli.

```
USAGE
  $ bf config

OPTIONS
  -h, --help  config help
```

_See code: [src\commands\config\index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/blob/v4.15.0/src\commands\config\show\telemetry.ts)_
<!-- commandsstop -->
* [`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)
* [`bf config:set:telemetry`](#bf-configsettelemetry)
* [`bf config:show`](#bf-configshow)
* [`bf config:show:luis`](#bf-configshowluis)
* [`bf config:show:qnamaker`](#bf-configshowqnamaker)
* [`bf config:show:telemetry`](#bf-configshowtelemetry)

## `bf config`

Configure various settings within the cli.

```
USAGE
  $ bf config

OPTIONS
  -h, --help  config help
```

_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

```
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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/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](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/show/telemetry.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/@microsoft/bf-cli-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
