Skip to content

eliagrego/botframework-cli

 
 

Repository files navigation

BF Command Line Interface

Build Status Coverage Status

As part of the effort to improve Bot Framework SDK toolset we are happy to announce the introduction of a new Command Line Interface tool which will eventually replace the suite of tools currently used during Bot development. The new CLI, called BF is being released as an early preview. We have migrated Chatdown as a first proof of concept plugin. The new Chatdown plugin is fully functional and identical to the standalone tool (with some minor usage bug fixes). Early adopters are welcome to switch to the new CLI. In the meantime the old and new tools will exist side by side for at least a full release cycle.

Available Commands

The following commands are currently available:

Plugin Architecture

BF CLI is based on OClif Framework and inherits its command line parsing style, and plugin architecture.

Installation

BF is based on the Node.js platform. You must download the following prerequisties:

  • Node.js version 10.14.1 or higher

Install the tool using the following command:

npm i -g @microsoft/botframework-cli

To view detailed usage information see the CLI ReadMe page

Issues and Feature Requests

Please file issues and feature requests here.

Thank you for your support.

Privacy

Privacy is very important to us. BF CLI contains optional instrumentation that is designed to help us improve the tool based on anonymous usage patterns. It is disabled, opted-out by default. If you elect to opt-in, we will gather some usage data as follows:

  • Command group calls
  • Flags used excluding specific values (i.e. if used parameter --folder:name, we will only gather the use of --folder but will not capture name).

At any time you may disable data collection by changing the configuration using command:

bf config:telemetry:disable

Please refer to Microsoft Privacy Statement for more details.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

About

CLI Tools for the Microsoft Bot Framework

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 75.1%
  • TypeScript 19.5%
  • C# 4.7%
  • Other 0.7%