# Bishop

> Bishop puts an agent where your team already works: Slack, email and Microsoft Teams. Install it, run it, and deploy it.

## Table of Contents

### Get Started

- [Quick Start](https://bishop.agentdeployment.co/index.md): What Bishop is, what you need, and the commands that get an agent answering in Slack, email or Teams.
- [Install](https://bishop.agentdeployment.co/install.md): Installing Bishop from npm or from source, and the Node version it needs.
- [How It Works](https://bishop.agentdeployment.co/how-it-works.md): The pieces of Bishop, what happens during a turn, and what it keeps on disk.

### Interfaces

- [Slack](https://bishop.agentdeployment.co/interfaces/slack.md): Connecting Bishop to Slack over Socket Mode, how threads work, and the scopes it needs.
- [Email](https://bishop.agentdeployment.co/interfaces/email.md): Connecting Bishop to a Google Workspace mailbox, and which mail the agent never answers.
- [Microsoft Teams](https://bishop.agentdeployment.co/interfaces/teams.md): Connecting Bishop to Microsoft Teams, including the HTTPS endpoint Teams delivers to.
- [Commands](https://bishop.agentdeployment.co/interfaces/commands.md): Messages to Bishop itself in Slack or Teams, like changing verbosity or the model, or stopping a turn.

### Running Bishop

- [Choosing the Agent](https://bishop.agentdeployment.co/running/agent.md): Pointing Bishop at an agent in a directory or a git repository, and picking up a push without restarting.
- [Harness and Model](https://bishop.agentdeployment.co/running/harness.md): Choosing between the Claude and Codex harnesses, model credentials, and model and effort settings.
- [Access](https://bishop.agentdeployment.co/running/access.md): Each interface's allow list, which decides who can reach the agent.
- [GitHub](https://bishop.agentdeployment.co/running/github.md): Giving the agent its own GitHub credential, limiting what it can reach, and pushing with git.
- [Worktree Mode](https://bishop.agentdeployment.co/running/worktrees.md): Giving each thread its own git worktree so threads don't write over each other's files.
- [Sandbox](https://bishop.agentdeployment.co/running/sandbox.md): Running the agent under nono so it can't read Bishop's credentials, database or other threads' files.
- [Files](https://bishop.agentdeployment.co/running/files.md): How files people attach reach the agent, and how the agent sends files back.
- [Scheduled Prompts](https://bishop.agentdeployment.co/running/schedules.md): Running a prompt on a schedule and posting the answer only when the agent has something to say.

### Deploying

- [Deploying](https://bishop.agentdeployment.co/deploying.md): Running Bishop under any process supervisor, with what it needs from the network, where it logs, and what has to persist.
- [Linux and systemd](https://bishop.agentdeployment.co/deploying/linux.md): Running Bishop on a Linux host under systemd, with the packages, directories and unit it needs.
- [Container](https://bishop.agentdeployment.co/deploying/container.md): Running the Bishop container image, with its volumes, setup commands and tags.
- [Cleaning Up](https://bishop.agentdeployment.co/deploying/cleanup.md): How Bishop removes what old conversations leave behind, and how to run that yourself.
- [Upgrading](https://bishop.agentdeployment.co/deploying/upgrading.md): Upgrading Bishop, database migrations, and rolling back.
- [Troubleshooting](https://bishop.agentdeployment.co/deploying/troubleshooting.md): What to check when Bishop won't start, an agent doesn't answer, or setup fails.

### Reference

- [Configuration](https://bishop.agentdeployment.co/reference/config.md): Every field in .bishop/config.json.
- [Credentials](https://bishop.agentdeployment.co/reference/credentials.md): Every credential Bishop reads, and where it reads them from.
- [CLI Reference](https://bishop.agentdeployment.co/reference/cli.md): Every bishop command and flag, generated from bishop --help.
- [Limits](https://bishop.agentdeployment.co/reference/limits.md): What this version of Bishop doesn't do.



## Optional

- [Changelog](https://bishop.agentdeployment.co/reference/changelog.md): What changed in each released version of Bishop.