UNPKG

3.04 kBMarkdownView Raw
1botonic
2=======
3
4Build chatbots using React
5
6[![Version](https://img.shields.io/npm/v/botonic.svg)](https://npmjs.org/package/botonic)
7[![CircleCI](https://circleci.com/gh/ericmarcos/botonic/tree/master.svg?style=shield)](https://circleci.com/gh/ericmarcos/botonic/tree/master)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/ericmarcos/botonic?branch=master&svg=true)](https://ci.appveyor.com/project/ericmarcos/botonic/branch/master)
9[![Codecov](https://codecov.io/gh/ericmarcos/botonic/branch/master/graph/badge.svg)](https://codecov.io/gh/ericmarcos/botonic)
10[![Downloads/week](https://img.shields.io/npm/dw/botonic.svg)](https://npmjs.org/package/botonic)
11[![License](https://img.shields.io/npm/l/botonic.svg)](https://github.com/ericmarcos/botonic/blob/master/package.json)
12
13<!-- toc -->
14* [Usage](#usage)
15* [Commands](#commands)
16<!-- tocstop -->
17# Usage
18<!-- usage -->
19```sh-session
20$ npm install -g botonic
21$ botonic COMMAND
22running command...
23$ botonic (-v|--version|version)
24botonic/0.1.4 darwin-x64 node-v9.9.0
25$ botonic --help [COMMAND]
26USAGE
27 $ botonic COMMAND
28...
29```
30<!-- usagestop -->
31# Commands
32<!-- commands -->
33* [botonic deploy [BOT_NAME]](#botonic-deploy-bot-name)
34* [botonic help [COMMAND]](#botonic-help-command)
35* [botonic input [INPUT]](#botonic-input-input)
36* [botonic new [BOT_NAME]](#botonic-new-bot-name)
37* [botonic run [INPUT]](#botonic-run-input)
38
39## botonic deploy [BOT_NAME]
40
41Deploy Botonic project to botonic.io cloud
42
43```
44USAGE
45 $ botonic deploy [BOT_NAME]
46
47EXAMPLE
48 $ botonic deploy
49 Deploying...
50 🚀 test_bot was successfully deployed!
51```
52
53_See code: [src/commands/deploy.ts](https://github.com/hubtype/botonic/blob/v0.1.4/src/commands/deploy.ts)_
54
55## botonic help [COMMAND]
56
57display help for botonic
58
59```
60USAGE
61 $ botonic help [COMMAND]
62
63ARGUMENTS
64 COMMAND command to show help for
65
66OPTIONS
67 --all see all commands in CLI
68```
69
70_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v1.2.3/src/commands/help.ts)_
71
72## botonic input [INPUT]
73
74Get response from a single input
75
76```
77USAGE
78 $ botonic input [INPUT]
79
80OPTIONS
81 -p, --path=path Path to botonic project. Defaults to current dir.
82
83EXAMPLE
84 $ botonic input "{"type": "text", "data": "hi"}"
85 Hello!
86```
87
88_See code: [src/commands/input.ts](https://github.com/hubtype/botonic/blob/v0.1.4/src/commands/input.ts)_
89
90## botonic new [BOT_NAME]
91
92Create a new Botonic project
93
94```
95USAGE
96 $ botonic new [BOT_NAME]
97
98EXAMPLE
99 $ botonic new test_bot
100 Creating...
101 💫 test_bot was successfully created!
102```
103
104_See code: [src/commands/new.ts](https://github.com/hubtype/botonic/blob/v0.1.4/src/commands/new.ts)_
105
106## botonic run [INPUT]
107
108Start interactive session
109
110```
111USAGE
112 $ botonic run [INPUT]
113
114OPTIONS
115 -p, --path=path Path to botonic project. Defaults to current dir.
116
117EXAMPLE
118 $ botonic run
119 Your bot is ready, start talking:
120 [you] > Hi
121 [bot] > Bye!
122```
123
124_See code: [src/commands/run.ts](https://github.com/hubtype/botonic/blob/v0.1.4/src/commands/run.ts)_
125<!-- commandsstop -->