@microsoft/bf-cli-plugins

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.

Synopsis

BF plugins command group allows you to extend the CLI with preview commands. Only microsoft scoped plugins are allowed to be installed.

Available plugins

@microsoft/bf-dialog

npm config set registry https://botbuilder.myget.org/F/botframework-cli/npm/

bf plugins:install @microsoft/bf-dialog

npm config set registry https://registry.npmjs.org/

• Commands

• Commands

Commands

• bf plugins
• bf plugins:install PLUGIN
• bf plugins:link PLUGIN
• bf plugins:list
• bf plugins:uninstall [PLUGIN]

bf plugins

Install, uninstall and show installed plugins

USAGE
  $ bf plugins

OPTIONS
  --help  Display plugins commands help.

See code: src\commands\plugins\index.ts

bf plugins:install PLUGIN

Installs a plugin into the BF CLI

USAGE
  $ bf plugins:install PLUGIN

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  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

See code: src\commands\plugins\install.ts

bf plugins:link PLUGIN

Links a plugin into the BF CLI for development

USAGE
  $ bf plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.
  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

See code: src\commands\plugins\link.ts

bf plugins:list

List installed plugins

USAGE
  $ bf plugins:list

OPTIONS
  --core  show core plugins

See code: src\commands\plugins\list.ts

bf plugins:uninstall [PLUGIN]

Removes a plugin from the BF CLI

USAGE
  $ bf plugins:uninstall [PLUGIN]

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: src\commands\plugins\uninstall.ts

• bf plugins
• bf plugins:install PLUGIN
• bf plugins:link PLUGIN
• bf plugins:list
• bf plugins:uninstall [PLUGIN]

bf plugins

Install, uninstall and show installed plugins

USAGE
  $ bf plugins

OPTIONS
  --help  Display plugins commands help.

See code: src/commands/plugins/index.ts

bf plugins:install PLUGIN

Installs a plugin into the BF CLI

USAGE
  $ bf plugins:install PLUGIN

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  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

See code: src/commands/plugins/install.ts

bf plugins:link PLUGIN

Links a plugin into the BF CLI for development

USAGE
  $ bf plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.
  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

See code: src/commands/plugins/link.ts

bf plugins:list

List installed plugins

USAGE
  $ bf plugins:list

OPTIONS
  --core  show core plugins

See code: src/commands/plugins/list.ts

bf plugins:uninstall [PLUGIN]

Removes a plugin from the BF CLI

USAGE
  $ bf plugins:uninstall [PLUGIN]

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: src/commands/plugins/uninstall.ts