UNPKG

4.36 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.4.1 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 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
44Deploy Botonic project to botonic.io cloud
45
46```
47USAGE
48 $ botonic deploy [BOT_NAME]
49
50EXAMPLE
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
62display help for botonic
63
64```
65USAGE
66 $ botonic help [COMMAND]
67
68ARGUMENTS
69 COMMAND command to show help for
70
71OPTIONS
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
79Get response from a single input
80
81```
82USAGE
83 $ botonic input INPUT
84
85OPTIONS
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
90EXAMPLE
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
99Log in to Botonic
100
101```
102USAGE
103 $ botonic login
104
105OPTIONS
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
113Log out of Botonic
114
115```
116USAGE
117 $ botonic logout
118
119OPTIONS
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
127Create a new Botonic project
128
129```
130USAGE
131 $ botonic new NAME [TEMPLATENAME]
132
133ARGUMENTS
134 NAME name of the bot folder
135 TEMPLATENAME OPTIONAL name of the bot template
136
137EXAMPLE
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
147Start interactive session
148
149```
150USAGE
151 $ botonic run [INPUT]
152
153OPTIONS
154 -p, --path=path Path to botonic project. Defaults to current dir.
155
156EXAMPLE
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
167Get response from a single input
168
169```
170USAGE
171 $ botonic webview WEBVIEW_PAGE
172
173OPTIONS
174 -c, --context=context Context of current session
175 -p, --path=path Path to botonic project. Defaults to current dir.
176
177EXAMPLE
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<!-- commandsstop -->