Bosun Documentation
Bosun is a control plane for autonomous software engineering. It routes work across executor backends, manages task and workflow lifecycles, enforces quality gates around pull requests, and keeps operators in control through Telegram, the Mini App, and optional desktop and voice surfaces.
These docs are static pages published from the repo. For repo-level deep dives, also see
README.md, docs/, and _docs/ in
virtengine/bosun.
What Bosun does
- Routes execution across Codex, Copilot, Claude, Gemini, and OpenCode integrations.
- Owns workflow lifecycles for planning, execution, validation, PR review, and recovery.
- Persists state for tasks, sessions, shared workspaces, and workflow runs.
- Operates safely with retries, watchdogs, review gates, trust checks, and recovery tooling.
- Exposes control surfaces through CLI, Telegram, Mini App, desktop, and optional voice mode.
Current platform shape
| Area | Current repo surface |
|---|---|
| Entry points | cli.mjs, setup.mjs, task/task-cli.mjs |
| Runtime | infra/, workflow/, workflow-templates/, task/ |
| Interfaces | server/, ui/, telegram/, desktop/,
voice/ |
| Integrations | github/, kanban/, shell/, workspace/ |
| Published docs | site/docs/ with supporting source material in docs/ and _docs/
|
Start here
Quick Start
Install Bosun, run setup, validate the environment, and launch the monitor.
Installation & Deployment
npm, source, Docker Hub, docker‑compose, and Electron — every way to install and run Bosun.
Configuration
Understand load order, `.env`, JSON config, executor settings, and integration knobs.
CLI Reference
See the current command surface for runtime, tasks, workspaces, and companion tools.
Architecture
Map the current module layout and how monitor, workflows, UI, and integrations connect.
Integrations
GitHub, Telegram, Jira, Cloudflare tunnels, containers, voice, and executor providers.
Recommended reading order
- Start with Quick Start if you are installing or evaluating Bosun.
- See Installation & Deployment for npm, Docker, source, and desktop options.
- Use Configuration to shape the runtime around your repos, executors, and channels.
- Keep CLI Reference open when operating Bosun from a terminal or automation.
- Read Architecture before changing workflows, server behavior, or runtime ownership.
- Use Integrations when wiring GitHub, Telegram, Jira, Cloudflare, or container execution.
Requirements
- Node.js 18+ with current development generally targeting modern Node 20/22+ environments.
- Git on PATH.
- PowerShell 7+ or Bash depending on your wrapper and host environment.
- GitHub CLI recommended for repository and PR workflows.
- Optional extras like cloudflared, Docker/Podman, and Telegram credentials depending on which surfaces you enable.