UNPKG

3.77 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.10 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
41## botonic deploy [BOT_NAME]
42
43Deploy Botonic project to botonic.io cloud
44
45```
46USAGE
47 $ botonic deploy [BOT_NAME]
48
49EXAMPLE
50 $ botonic deploy
51 Building...
52 Creating bundle...
53 Uploading...
54 🚀 Bot deployed!
55```
56
57_See code: [src/commands/deploy.ts](https://github.com/hubtype/botonic/blob/v0.1.10/src/commands/deploy.ts)_
58
59## botonic help [COMMAND]
60
61display help for botonic
62
63```
64USAGE
65 $ botonic help [COMMAND]
66
67ARGUMENTS
68 COMMAND command to show help for
69
70OPTIONS
71 --all see all commands in CLI
72```
73
74_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v1.2.3/src/commands/help.ts)_
75
76## botonic input INPUT
77
78Get response from a single input
79
80```
81USAGE
82 $ botonic input INPUT
83
84OPTIONS
85 -p, --path=path Path to botonic project. Defaults to current dir.
86
87EXAMPLE
88 $ botonic input "{\"type\": \"text\", \"data\": \"hi\"}"
89 Hello!
90```
91
92_See code: [src/commands/input.ts](https://github.com/hubtype/botonic/blob/v0.1.10/src/commands/input.ts)_
93
94## botonic login
95
96Log in to Botonic
97
98```
99USAGE
100 $ botonic login
101
102OPTIONS
103 -p, --path=path Path to botonic project. Defaults to current dir.
104```
105
106_See code: [src/commands/login.ts](https://github.com/hubtype/botonic/blob/v0.1.10/src/commands/login.ts)_
107
108## botonic logout
109
110Log out of Botonic
111
112```
113USAGE
114 $ botonic logout
115
116OPTIONS
117 -p, --path=path Path to botonic project. Defaults to current dir.
118```
119
120_See code: [src/commands/logout.ts](https://github.com/hubtype/botonic/blob/v0.1.10/src/commands/logout.ts)_
121
122## botonic new NAME [TEMPLATENAME]
123
124Create a new Botonic project
125
126```
127USAGE
128 $ botonic new NAME [TEMPLATENAME]
129
130ARGUMENTS
131 NAME name of the bot folder
132 TEMPLATENAME OPTIONAL name of the bot template
133
134EXAMPLE
135 $ botonic new test_bot
136 Creating...
137 ✨ test_bot was successfully created!
138```
139
140_See code: [src/commands/new.ts](https://github.com/hubtype/botonic/blob/v0.1.10/src/commands/new.ts)_
141
142## botonic run [INPUT]
143
144Start interactive session
145
146```
147USAGE
148 $ botonic run [INPUT]
149
150OPTIONS
151 -p, --path=path Path to botonic project. Defaults to current dir.
152
153EXAMPLE
154 $ botonic run
155 Your bot is ready, start talking:
156 [you] > Hi
157 [bot] > Bye!
158```
159
160_See code: [src/commands/run.ts](https://github.com/hubtype/botonic/blob/v0.1.10/src/commands/run.ts)_
161<!-- commandsstop -->