Getting Started

yo is the Yeoman command line utility allowing the creation of projects utilizing scaffolding templates. Yo and the generators used are installed using npm.

generator-csebot is the Yeoman Generator with CI/CD for Microsoft Bot Framework a.k.a BotBuilder (this project).

Installing yo and csebot generator

First thing is to install yo using npm:

npm install -g yo

Then install the csebot generator. All Generators are npm named packages. Search for it (use the term generator-csebot) by selecting "install a generator" menu option while running yo. To directly install the csebot generator:

npm install -g generator-csebot

To use the main generator simply enter

   yo csebot

Demo

Using Sub Generators

If you want to use any of the sub generators individually simply add a : and the name of the desired sub generator. For example to create a project type

   yo csebot:project

Each generator will prompt you for the required information for that sub generator. If you prefer not to be prompted for values you can pass them all on the command line. To learn which arguments each generator takes type --help after the generator name

yo csebot:project --help Usage:

  yo csebot:build [options] [<type>] [<botName>] [<tfs>] [<queue>] [<target>] [<pat>]

Options:
  -h,   --help          # Print the generator's options and usage
        --skip-cache    # Do not remember prompt answers             Default: false
        --skip-install  # Do not automatically install dependencies  Default: false

Arguments:
  type     # project type to create (csharp, node, typescript)                Type: String  Required: false
  botName  # name of the Bot                                                  Type: String  Required: false
  tfs      # full tfs URL including collection or Team Services account name  Type: String  Required: false
  queue    # agent queue name to use                                          Type: String  Required: false
  target   # docker or Azure app service                                      Type: String  Required: false
  pat      # Personal Access Token to TFS/VSTS                                Type: String  Required: false

Any values you do not provide on the command line will be prompted for before the generator is run.