@axelspringer/hubots

A TypeScript flavor version of GitHubs famous and beloved Hubot

Usage no npm install needed!

<script type="module">
  import axelspringerHubots from 'https://cdn.skypack.dev/@axelspringer/hubots';
</script>

README

:space_invader: Hubots

A TypeScript flavor version of GitHubs famous Hubot


Taylor Swift Volkswagen TypeScript MIT license

Getting Started

requires a node version >= 6 and an npm version >= 3.x.x

we use Koa as middleware

# Installs hubots as global package
npm i @axelspringer/hubots -g

# Start hubot
hubots

Environment Variables

HUBOTS_SHELL_HISTSIZE

Sets the size of the .hubots_history and defaults to 1024.

HUBOTS_LOG_LEVEL

Sets the log level of Hubot and defaults to info.

HUBOTS_SHELL_USER_NAME

Sets the shell username and defaults to Shell.

HUBOTS_SHELL_USER_ID

Sets the shell user id and defaults to 1.

HUBOTS_PORT

Sets the port of the middleware and defaults to 8080

Development

all commands can be seen via npm run help

# Clone the repository
git clone https://github.com/axelspringer/hubots

# Start the local dev server
npm start

# You can also local link it to use `hubot`
npm link

Docker

You can also run Hubot in a Container. The middleware is exposed on 8080.

# Build the container
npm run build/docker

Have fun!

License

MIT