@bunbot/runtime

Lightweight bot runtime built on Bun for fast, simple deployments.

Install

npm install @bunbot/runtime
# or
bun add @bunbot/runtime

Quick start

import { createBot } from "@bunbot/runtime";

const bot = createBot({
  name: "bunbot",
  commands: [
    {
      name: "ping",
      description: "Ping the bot",
      handler: async (ctx) => {
        await ctx.reply("pong");
      },
    },
  ],
});

await bot.start();

Architecture

flowchart TD
  User["User / Platform"] -->|events, messages| Bot["Bot instance<br/>(@bunbot/runtime)"]
  Bot --> Router["Router"]
  Router --> Commands["Command handlers"]
  Router --> Middleware["Middleware & plugins"]
  Bot --> LLM["LLM Providers<br/>(OpenAI, Anthropic, Ollama, ...)"]
  Bot --> Telemetry["Telemetry / Langfuse"]
  Bot --> Health["HealthServer"]
  Health -->|/health, /message| HTTP["HTTP clients / monitors"]

Health server

@bunbot/runtime includes a tiny health server for uptime checks and simple command execution over HTTP.

import { HealthServer } from "@bunbot/runtime/server";

const server = new HealthServer({
  port: 3000,
  healthPath: "/health",
});

server.start(async ({ command, args }) => {
  if (command === "ping") return "pong";
  return null;
});

Publishing (maintainers)

To publish a new version:

bun install
bun run build
npm publish