# hubot-kato

> A kato.im adapter for hubot

Latest version **0.1.1** (published 2015-03-03) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install hubot-kato
pnpm add hubot-kato
yarn add hubot-kato
bun add hubot-kato
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-03-03 |
| First published | 2013-06-25 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.x |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Maintainers | JLarky, jlarky |
| Keywords | github hubot kato adapter |

## Links

- npm: https://www.npmjs.com/package/hubot-kato
- Repository: https://github.com/kato-im/hubot-kato
- Issues: https://github.com/kato-im/hubot-kato/issues
- npm.io page: https://npm.io/package/hubot-kato

## Dependencies (3)

- [hubot](https://npm.io/package/hubot.md) >=2.0.5
- [winston](https://npm.io/package/winston.md) >=0.8.0
- [websocket](https://npm.io/package/websocket.md) >=1.0.8

## Recent versions

- 0.1.1 (latest) — 2015-03-03
- 0.1.0 — 2014-11-20
- 0.0.9 — 2014-11-14
- 0.0.8 — 2014-05-13
- 0.0.7 — 2014-03-15
- 0.0.6 — 2013-09-03
- 0.0.5 — 2013-07-09
- 0.0.4 — 2013-06-25

## README

# Kato Hubot Adapter

## Description

The Kato Hubot adapter allows you to use [Hubot](https://hubot.github.com) in your Kato team.

## Installation

Install Hubot (consult the [Hubot documentation](https://github.com/github/hubot/tree/master/docs) for more information):

    $ sudo npm install -g yo generator-hubot

Create a new bot:

    $ mkdir myhubot
    $ cd myhubot
    $ yo hubot

You will be asked which adapter to use, type `kato`.

![image](https://cloud.githubusercontent.com/assets/7026/5053119/f7b3d6f8-6bfb-11e4-9359-10b3db318af7.png)

## Configuration

First, create a new Kato account for your bot. It’s best to create a new email address, eg. `kato-bot@mycompany.com` and invite this address to your Kato team. Verify the email and set a name for your bot in its new account (that name shows up when it posts a message).

Next, you will need to set some environment variables:

    $ export HUBOT_KATO_LOGIN="katobot@mycompany.com"
    $ export HUBOT_KATO_PASSWORD="5prz8OKty6"

## Usage

Once that’s done, you can start Hubot with Kato as the adapter:

    $ ./bin/hubot -a kato

Please ignore `npm WARN` and `deprecated` messages, they are generated by packages unrelated to the Kato adapter. You shoud be able to see your bot online in Kato just a few seconds after you ran this command.

### Notes

The Kato addapter supports listening for commands in

- all unrestricted rooms
- restricted rooms, to which it has been explicitly added
- 1 on 1 chats with the bot itself

You can address your bot by beginning a message with its name, which defaults to `Hubot`.
You can change this and also set an alias using the following additional environment vars:

    $ export HUBOT_NAME="Frank"
    $ export HUBOT_ALIAS="!"

Your bot should now reply to `!ping` with `PONG`.

The bot will not respond to itself.

### Optional Logging

Log filename (the default is `kato-hubot.log`):

    $ export HUBOT_KATO_LOG_FILE="path/filename.log"

Log level (one of `error`, `debug`, or `info`. Default is `error`):

    $ export HUBOT_KATO_LOG_LEVEL="debug"


## Copyright

Copyright © LeChat, Inc. See LICENSE for details.

---
_Source: https://npm.io/package/hubot-kato · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._