Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gasolin/saihubot
:speech_balloon: client side chatbot that works in the browser and command line
https://github.com/gasolin/saihubot
bot-framework browser-bot chat-bot chatbot hubot javascript-bot
Last synced: about 2 months ago
JSON representation
:speech_balloon: client side chatbot that works in the browser and command line
- Host: GitHub
- URL: https://github.com/gasolin/saihubot
- Owner: gasolin
- License: mit
- Created: 2016-08-05T09:35:19.000Z (over 8 years ago)
- Default Branch: gh-pages
- Last Pushed: 2023-03-06T10:34:15.000Z (almost 2 years ago)
- Last Synced: 2024-10-16T05:33:04.784Z (3 months ago)
- Topics: bot-framework, browser-bot, chat-bot, chatbot, hubot, javascript-bot
- Language: CSS
- Homepage: https://gasolin.github.io/saihubot/
- Size: 10.1 MB
- Stars: 18
- Watchers: 2
- Forks: 2
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Saihubot
[](https://lerna.js.org/) [](https://github.com/gasolin/saihubot/actions?query=workflow%3A%22Lint+Action%22)
:robot: Frontend Framework to build :speech_balloon: message/chat bots ops in the :globe_with_meridians: [Browser](https://gasolin.github.io/saihubot/) or [Command Line](https://www.npmjs.com/package/saihu), no server required.
You can add new skills to bot via `skills` and extend its ability via `addons`. All with plain javascript. :clap:
Saihubot's API is inspired by [hubot](https://github.com/github/hubot/)'s API, so a developer who has learned `hubot-plugins` could learn `saihu-skills` very quickly. :zap:
Check [Online Demo](https://gasolin.github.io/saihubot/)
Or run the command bot without install
```sh
npx saihu npm saihu
```
## Features
* Chatbot works in multiple platforms, without server setup.
* Structure was inspired by [hubot](https://github.com/github/hubot/)
* Regex based message matching
* Could write adapter to fully cooperate with your web UI
* Could swap brain to support different backends
* Provide skills(pluginn) architecture that able to expand functions
* Can extend bot functionality by import addons
* Tiny size, easy to learn (the init version has just 80 lines that bundle with three skills)
* Plugin callbacks are extremely flexible; You can control in-page elements, execute the local command, fetch remote data, trigger remote actions...
## Modules
| Module | Version | Description | Doc |
| --------|---------|-------------|-----|
| [saihubot](https://github.com/gasolin/saihubot/tree/gh-pages/packages/saihubot#readme) | [](https://www.npmjs.com/package/saihubot) | core module|[Doc](http://gasolin.idv.tw/saihubot/docs/saihubot/) |
| [saihu](https://github.com/gasolin/saihubot/tree/gh-pages/packages/cli#readme) | [](https://www.npmjs.com/package/saihu) | Sample Command line bot |[Doc](http://gasolin.idv.tw/saihubot/docs/saihu) |
| [Web samples](https://github.com/gasolin/saihubot/tree/gh-pages/samples) | [Online Demos](https://gasolin.github.io/saihubot/) | |
| Adapters | Version | Description | Doc |
| --------|---------|-------------|-----|
|[saihubot-html-adapter](https://github.com/gasolin/saihubot/tree/gh-pages/packages/html-adapter#readme) |[](https://www.npmjs.com/package/saihubot-html-adapter) |HTML |[Doc](http://gasolin.idv.tw/saihubot/docs/saihubot-html-adapter) |
|[saihubot-react-redux-adapter](https://github.com/gasolin/saihubot/tree/gh-pages/packages/react-redux-adapter#readme) |[](https://www.npmjs.com/package/saihubot-react-redux-adapter) |React + Redux |[Doc](http://gasolin.idv.tw/saihubot/docs/saihubot-react-redux-adapter) |
|[saihubot-cli-adapter](https://github.com/gasolin/saihubot/tree/gh-pages/packages/cli-adapter#readme) |[](https://www.npmjs.com/package/saihubot-cli-adapter.svg) |Command Line |[Doc](http://gasolin.idv.tw/saihubot/docs/saihubot-cli-adapter) |
| Skills | Version | Description | Doc |
| --------|---------|-------------|-----|
|[saihubot-skill-search](https://github.com/gasolin/saihubot/tree/gh-pages/packages/skill-search#readme) |[](https://www.npmjs.com/package/saihubot-skill-search) | Search engines |[Doc](http://gasolin.idv.tw/saihubot/docs/saihubot-skill-search) |
|[saihubot-skill-diagnostics](https://github.com/gasolin/saihubot/tree/gh-pages/packages/skill-diagnostics#readme) |[](https://www.npmjs.com/package/saihubot-skill-diagnostics) | ping, echo, current time | [Doc](http://gasolin.idv.tw/saihubot/docs/saihubot-skill-diagnostics) |
|[saihubot-cli-skill-qrcode](https://github.com/gasolin/saihubot/tree/gh-pages/packages/cli-skill-qrcode#readme) |[](https://www.npmjs.com/package/saihubot-cli-skill-qrcode) | generate qrcode | [Doc](http://gasolin.idv.tw/saihubot/docs/saihubot-cli-skill-qrcode) |
## How to use
### Try Saihubot samples online
If you just want to try how the saihubot looks like, Check [Online Demo](https://gasolin.github.io/saihubot/)
### Try Saihubot locally
Clone the project with command
```sh
git clone https://github.com/gasolin/saihubot.git
```
Then run
```sh
npm build
npm start
```
or
```sh
npx http-server .
```
now you have a working bot in the browser!
### Try Saihubot on Github
Fork the project, edit index.html with Github editor, save it and see the result on https://[yourname].github.io/saihubot
Saihubot also provide Search skills, you can include it via `skillsFile: ['skills/saihubot-search.js']`
Check the [Search Demo](https://gasolin.github.io/saihubot/samples/search).
### :mag_right: Google Search skill:
```
me: g saihubot
bot: Search saihubot via Google
me: google saihubot
bot: Search saihubot via Google
me: search saihubot
bot: Search saihubot via Google
```
## Want to learn more?
Check the [docs](https://github.com/gasolin/saihubot/tree/gh-pages/docs) section.
## What Saihu means?
Saihu(`師傅`) means `master` in Taiwanese, which people used to call the artisans.
Saihubot's origin goal is to provide a code sample that makes learning [hubot](https://github.com/github/hubot/) and its ES6 variant [Webbybot](https://github.com/gasolin/webbybot/) easier; then I found Saihu is a great way to embed bot into anywhere browser can live with.
## License
Saihubot use MIT License
## ChangeLog
Check [ChangeLog](CHANGELOG.md)