imubot/docs/adapters/shell.md

A simple helpful bot.

---
permalink: /docs/adapters/shell/index.html
layout: docs
---

The shell adapter provides a simple read-eval-print loop for interacting with a mubot locally.
It can be useful for testing scripts before using them on a live mubot.

## Getting Started

To use the shell adapter you can simply omit the `-a` option when running
mubot as it will use the shell adapter by default.

    % bin/mubot

## Configuring

This adapter doesn't require any configuration.

It supports two environment variables to make it possible to test scripts as different users:

* MUBOT_SHELL_USER_ID: default is 1
* MUBOT_SHELL_USER_NAME: default is Shell