1 | botonic
|
2 | =======
|
3 |
|
4 | Build 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 |
|
14 | * [Usage](#usage)
|
15 | * [Commands](#commands)
|
16 |
|
17 | # Usage
|
18 |
|
19 | ```sh-session
|
20 | $ npm install -g botonic
|
21 | $ botonic COMMAND
|
22 | running command...
|
23 | $ botonic (-v|--version|version)
|
24 | botonic/0.4.1 darwin-x64 node-v9.9.0
|
25 | $ botonic --help [COMMAND]
|
26 | USAGE
|
27 | $ botonic COMMAND
|
28 | ...
|
29 | ```
|
30 |
|
31 | # Commands
|
32 |
|
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 login](#botonic-login)
|
37 | * [botonic logout](#botonic-logout)
|
38 | * [botonic new NAME [TEMPLATENAME]](#botonic-new-name-templatename)
|
39 | * [botonic run [INPUT]](#botonic-run-input)
|
40 | * [botonic webview WEBVIEW_PAGE](#botonic-webview-webview-page)
|
41 |
|
42 | ## botonic deploy [BOT_NAME]
|
43 |
|
44 | Deploy Botonic project to botonic.io cloud
|
45 |
|
46 | ```
|
47 | USAGE
|
48 | $ botonic deploy [BOT_NAME]
|
49 |
|
50 | EXAMPLE
|
51 | $ botonic deploy
|
52 | Building...
|
53 | Creating bundle...
|
54 | Uploading...
|
55 | 🚀 Bot deployed!
|
56 | ```
|
57 |
|
58 | _See code: [src/commands/deploy.ts](https://github.com/hubtype/botonic/blob/v0.4.1/src/commands/deploy.ts)_
|
59 |
|
60 | ## botonic help [COMMAND]
|
61 |
|
62 | display help for botonic
|
63 |
|
64 | ```
|
65 | USAGE
|
66 | $ botonic help [COMMAND]
|
67 |
|
68 | ARGUMENTS
|
69 | COMMAND command to show help for
|
70 |
|
71 | OPTIONS
|
72 | --all see all commands in CLI
|
73 | ```
|
74 |
|
75 | _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v1.2.3/src/commands/help.ts)_
|
76 |
|
77 | ## botonic input INPUT
|
78 |
|
79 | Get response from a single input
|
80 |
|
81 | ```
|
82 | USAGE
|
83 | $ botonic input INPUT
|
84 |
|
85 | OPTIONS
|
86 | -c, --context=context Context of current session
|
87 | -p, --path=path Path to botonic project. Defaults to current dir.
|
88 | -r, --route=route Route of the current bot state.
|
89 |
|
90 | EXAMPLE
|
91 | $ botonic input "{\"type\": \"text\", \"data\": \"hi\"}"
|
92 | Hello!
|
93 | ```
|
94 |
|
95 | _See code: [src/commands/input.ts](https://github.com/hubtype/botonic/blob/v0.4.1/src/commands/input.ts)_
|
96 |
|
97 | ## botonic login
|
98 |
|
99 | Log in to Botonic
|
100 |
|
101 | ```
|
102 | USAGE
|
103 | $ botonic login
|
104 |
|
105 | OPTIONS
|
106 | -p, --path=path Path to botonic project. Defaults to current dir.
|
107 | ```
|
108 |
|
109 | _See code: [src/commands/login.ts](https://github.com/hubtype/botonic/blob/v0.4.1/src/commands/login.ts)_
|
110 |
|
111 | ## botonic logout
|
112 |
|
113 | Log out of Botonic
|
114 |
|
115 | ```
|
116 | USAGE
|
117 | $ botonic logout
|
118 |
|
119 | OPTIONS
|
120 | -p, --path=path Path to botonic project. Defaults to current dir.
|
121 | ```
|
122 |
|
123 | _See code: [src/commands/logout.ts](https://github.com/hubtype/botonic/blob/v0.4.1/src/commands/logout.ts)_
|
124 |
|
125 | ## botonic new NAME [TEMPLATENAME]
|
126 |
|
127 | Create a new Botonic project
|
128 |
|
129 | ```
|
130 | USAGE
|
131 | $ botonic new NAME [TEMPLATENAME]
|
132 |
|
133 | ARGUMENTS
|
134 | NAME name of the bot folder
|
135 | TEMPLATENAME OPTIONAL name of the bot template
|
136 |
|
137 | EXAMPLE
|
138 | $ botonic new test_bot
|
139 | Creating...
|
140 | ✨ test_bot was successfully created!
|
141 | ```
|
142 |
|
143 | _See code: [src/commands/new.ts](https://github.com/hubtype/botonic/blob/v0.4.1/src/commands/new.ts)_
|
144 |
|
145 | ## botonic run [INPUT]
|
146 |
|
147 | Start interactive session
|
148 |
|
149 | ```
|
150 | USAGE
|
151 | $ botonic run [INPUT]
|
152 |
|
153 | OPTIONS
|
154 | -p, --path=path Path to botonic project. Defaults to current dir.
|
155 |
|
156 | EXAMPLE
|
157 | $ botonic run
|
158 | Your bot is ready, start talking:
|
159 | [you] > Hi
|
160 | [bot] > Bye!
|
161 | ```
|
162 |
|
163 | _See code: [src/commands/run.ts](https://github.com/hubtype/botonic/blob/v0.4.1/src/commands/run.ts)_
|
164 |
|
165 | ## botonic webview WEBVIEW_PAGE
|
166 |
|
167 | Get response from a single input
|
168 |
|
169 | ```
|
170 | USAGE
|
171 | $ botonic webview WEBVIEW_PAGE
|
172 |
|
173 | OPTIONS
|
174 | -c, --context=context Context of current session
|
175 | -p, --path=path Path to botonic project. Defaults to current dir.
|
176 |
|
177 | EXAMPLE
|
178 | $ botonic webview webview_hello"
|
179 | Hello!
|
180 | ```
|
181 |
|
182 | _See code: [src/commands/webview.ts](https://github.com/hubtype/botonic/blob/v0.4.1/src/commands/webview.ts)_
|
183 |
|