@conversationlearner/cli

@conversationlearner/cli

Command Line Interface for Microsoft Conversation Learner

• Usage
• Commands
• Contributing

Usage

$ npm install -g @conversationlearner/cli
$ cl COMMAND
running command...
$ cl (-v|--version|version)
@conversationlearner/cli/0.2.0 win32-x64 node-v8.2.1
$ cl --help [COMMAND]
USAGE
  $ cl COMMAND
...

Commands

• cl apps
• cl apps:create NAME
• cl config
• cl config:clear
• cl config:get KEY
• cl config:set KEY [VALUE]
• cl entities
• cl help [COMMAND]
• cl new NAME

cl apps

List applications

USAGE
  $ cl apps

OPTIONS
  -h, --help                                 show CLI help
  --apimSubscriptionKey=apimSubscriptionKey
  --luisAuthoringKey=luisAuthoringKey

ALIASES
  $ cl apps:list

EXAMPLE
  $ cl apps

See code: src/commands/apps.ts

cl apps:create NAME

Create application

USAGE
  $ cl apps:create NAME

OPTIONS
  -h, --help                                 show CLI help
  --apimSubscriptionKey=apimSubscriptionKey
  --luisAuthoringKey=luisAuthoringKey

EXAMPLE
  $ cl apps:create my-new-app

See code: src/commands/apps/create.ts

cl config

view configuration

USAGE
  $ cl config

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ cl config:index
  $ cl config:list

EXAMPLE
  $ cl config
        
  baseServiceUrl = <url>
  luisAuthoringKey = <Key>
  appId = <GUID>

See code: src/commands/config.ts

cl config:clear

reset configuration

USAGE
  $ cl config:clear

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ cl config:reset

EXAMPLE
  $ cl config clear

See code: src/commands/config/clear.ts

cl config:get KEY

Get configuration value

USAGE
  $ cl config:get KEY

See code: src/commands/config/get.ts

cl config:set KEY [VALUE]

set configuration value

USAGE
  $ cl config:set KEY [VALUE]

OPTIONS
  -h, --help  show CLI help

EXAMPLES
  $ cl config:set <key> <value>

  $ cl config:set luisAuthoringKey 123

  $ cl config:set appId 456

See code: src/commands/config/set.ts

cl entities

View entities

USAGE
  $ cl entities

OPTIONS
  -h, --help                           show CLI help
  --appId=appId
  --luisAuthoringKey=luisAuthoringKey

ALIASES
  $ cl entities:index
  $ cl entities:list

EXAMPLE
  $ cl entities

See code: src/commands/entities.ts

cl help [COMMAND]

display help for cl

USAGE
  $ cl help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cl new NAME

Create conversation learner project

USAGE
  $ cl new NAME

OPTIONS
  -h, --help                                 show CLI help
  --luisAuthoringKey=luisAuthoringKey
  --luisSubscriptionKey=luisSubscriptionKey

EXAMPLES
  $ cl new my-bot-01

  $ cl new my-bot-01 --luisAuthoringKey=XXX --luisSubscriptionKey=YYY

See code: src/commands/new.ts

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 [e-mail] with any additional questions or comments.