|
| 1 | + |
| 2 | + |
| 3 | + |
| 4 | + |
1 | 5 | # BF Command Line Interface |
2 | 6 |
|
3 | 7 | [](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=537&branchName=master) |
4 | 8 | [](https://coveralls.io/github/microsoft/botframework-cli?branch=master) |
5 | 9 |
|
6 | 10 | The new BF Command Line Interface (CLI) tool replaces the collection of standalone tools used to manage Bot Framework bots and related services. We have ported most tools and are in process of porting the rest. The new BF CLI aggregates the collection of cross-platform tools into one cohesive and consistent interface. |
7 | 11 |
|
8 | | -The old tools will be deprecated in subsequent releases. All new investments, bug fixes, and new features will be implemented in the new consolided BF CLI alone. |
| 12 | +The old tools will be deprecated in subsequent releases. All new investments, bug fixes, and new features will be implemented in the new consolidated BF CLI alone. |
| 13 | + |
| 14 | +## Installation |
| 15 | + |
| 16 | +BF is based on the Node.js platform and the [OClif](https://github.com/oclif/oclif) framework where it inherits its command line parsing style, and plugin architecture platform. |
| 17 | + |
| 18 | +You must download the following prerequisites: |
| 19 | + |
| 20 | +* [Node.js](https://nodejs.org/) version 10.14.1 or higher |
| 21 | + |
| 22 | +Install the tool using the following command: |
| 23 | + |
| 24 | +~~~ |
| 25 | +$ npm i -g @microsoft/botframework-cli |
| 26 | +$ bf |
| 27 | +~~~ |
9 | 28 |
|
10 | 29 | ## Available Commands |
11 | 30 | The following commands are currently available: |
12 | 31 | * [Chatdown](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-chatdown) |
13 | 32 | * [QnAMaker](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-qnamaker) |
14 | 33 | * [Config](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-config) |
15 | | -* [Luis](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-luis) |
| 34 | +* [Luis](https://github.com/microsoft/botframework-cli/tree/emimunoz/luis/packages/cli#bf-luis) |
16 | 35 |
|
17 | | -### Future Commands |
| 36 | +#### Future Commands |
18 | 37 | The following commands will be ported in upcoming releases: |
19 | 38 | * LUIS (API) |
20 | 39 | * Dispatch |
21 | 40 |
|
22 | 41 | See [Porting Map](https://github.com/microsoft/botframework-cli/blob/master/PortingMap.md) for a mapping reference between old and new tools |
23 | 42 |
|
| 43 | +## Overview |
24 | 44 |
|
25 | | -## Plugin Architecture |
26 | | -BF CLI is based on [OClif](https://github.com/oclif/oclif) Framework and inherits its command line parsing style, and plugin architecture. |
| 45 | +The Bot Framework Command Line Interface (BF CLI) cross-platform tool is used to manage Bot Framework bots and related services. It is part the [Microsoft Bot Framework](https://github.com/Microsoft/botframework), a comprehensive framework for building enterprise-grade conversational AI experiences. In particular, BF CLI provides fundamental functionality when used in conjunction with Continuous Integration, and Continuous Deployment (CI/CD) pipelines. |
27 | 46 |
|
28 | | -## Installation |
| 47 | +As you build your bot, you may also need to integrate AI services like [LUIS.ai](http://luis.ai) for language understanding, [QnAMaker.ai](http://qnamaker.ai) for your bot to respond to simple questions in a Q&A format, and more. The _[bf luis](./packages/cli#bf-luis)_ command is used to convert, and translate language definition _.lu_ files or generate corresponding source (C# or JavaScript) code. Then, use the [Luis Tool](https://github.com/microsoft/botbuilder-tools/tree/master/packages/LUIS) to deploy the local files, train, test, and publish them as Language Understanding models within the LUIS service. If used to define QnAMaker question/answer Knowledgebase, use the _[bf qnamaker](./packages/cli#bf-qnamaker)_ command to create and manage QnAMaker assets both locally, and on the QnAMaker service. Please refer to the[ _lu_ library documentation](./packages/Ludown) for extended discussion on how to work with .lu file formats. _Note: You may be familiar with the Luis command if you used the legacy [LuDown](https://github.com/microsoft/botbuilder-tools/tree/master/packages/Ludown) and [LuisGen](https://github.com/microsoft/botbuilder-tools/tree/master/packages/LUISGen) tools._ |
29 | 48 |
|
30 | | -BF is based on the Node.js platform. You must download the following __prerequisties__: |
| 49 | +As your bot grows in sophistication, use [Dispatch](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/Dispatch) CLI to create and evaluate LUIS models used to dispatch intent across multiple bot modules such as LUIS models, QnA knowledgebases, and assist in routing messages to backend bot skills. |
31 | 50 |
|
32 | | -* [Node.js](https://nodejs.org/) version 10.14.1 or higher |
| 51 | +To test and refine your bot, you can use the new [V4 Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases). The Bot Framework Emulator is a cross-platform [Electron](https://electronjs.org/) application that enables you to test and debug your bots on local machine or in the cloud. |
33 | 52 |
|
34 | | -Install the tool using the following command: |
| 53 | +Also, during early designs stages you may want to create mockup of conversations between the user and the bot for the specific scenarios your bot will support. Use [bf chatdown](./packages/Chatdown) command to author conversation mockup .chat files and convert them into rich transcripts and view the conversations in the the Emulator. |
| 54 | + |
| 55 | +Lastly, with the [Azure CLI Bot extension](./AzureCli.md) (_az bot_ command), you can create, download, publish, configure channels with the [Azure Bot Service](https://azure.microsoft.com/en-us/services/bot-service/). It is a plugin that extends the functionality of Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) to manage your Azure Bot Service assets. |
35 | 56 |
|
36 | | -~~~ |
37 | | -npm i -g @microsoft/botframework-cli |
38 | | -~~~ |
39 | 57 |
|
40 | | -To view detailed usage information see the [CLI ReadMe page](https://github.com/microsoft/botframework-cli/tree/master/packages/cli) |
| 58 | +### See Also |
| 59 | +* [Detailed Usage Information](https://github.com/microsoft/botframework-cli/tree/master/packages/cli) |
| 60 | +* [Bot Framework Homepage](https://dev.botframework.com/) |
| 61 | +* [Azure Bot Service](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0) |
| 62 | +* [LUIS](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/index) |
| 63 | +* [QnAMaker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/) |
| 64 | +* [Bot Design Guidelines](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-design-principles) |
41 | 65 |
|
42 | 66 | ## Issues and Feature Requests |
43 | 67 | Please file issues and feature requests [here](https://github.com/microsoft/botframework-cli/issues). |
@@ -68,3 +92,9 @@ provided by the bot. You will only need to do this once across all repos using o |
68 | 92 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
69 | 93 | For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
70 | 94 | contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |
| 95 | + |
| 96 | +## Reporting Security Issues |
| 97 | + |
| 98 | +Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [[email protected]](mailto:[email protected]). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the [MSRC PGP ](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the [Security TechCenter ](https://technet.microsoft.com/en-us/security/default). |
| 99 | + |
| 100 | +Copyright (c) Microsoft Corporation. All rights reserved. |
0 commit comments