# Bun Docs (English)

> A task-oriented Bun index for human newcomers and AI agents.

# Practical Bun Docs

> Task-oriented Bun docs for newcomers and AI agents

- [Practical Bun Docs](/en/docs): A bilingual, task-oriented Bun knowledge base for newcomers and AI agents

- **Get started**
- Get started: From installation to a tested service
  - [5-minute quickstart](/en/docs/getting-started/quickstart): Install Bun, create a TypeScript HTTP service, and run a test
  - [Build the mental model first](/en/docs/getting-started/mental-model): Understand Bun's four roles through familiar Node.js tooling

- **Core toolchain**
- Core toolchain: Run, install, organize monorepos, test, bundle, and access data
  - [Runtime](/en/docs/core/runtime): Run TypeScript, execute scripts, read environment variables, and serve HTTP
  - [WebSocket and realtime](/en/docs/core/websockets): Connection management, pub/sub, backpressure, and keepalive with Bun.serve's native WebSocket
  - [Package manager](/en/docs/core/package-manager): Manage dependencies, lockfiles, workspaces, and reproducible CI installs
  - [Monorepos and workspaces](/en/docs/core/monorepo): Maintain reproducible monorepos with Bun Workspaces, Catalogs, isolated installs, and filters
  - [Test runner](/en/docs/core/test-runner): Write bun:test suites, isolate dependencies, and run stable CI tests
  - [Bundler](/en/docs/core/bundler): Build deployable artifacts for browsers, Bun, or Node.js
  - [Frontend development with HTML imports](/en/docs/core/frontend): Run HTML, TypeScript, and CSS directly on Bun's fullstack dev server, and ship correct production builds
  - [Data and storage](/en/docs/core/data-and-storage): Choose Bun.SQL, SQLite, Redis, S3, and Drizzle while managing connections and production boundaries

- **Production deployment**
- Cloud & deployment: Deploy Bun correctly to containers, serverless, and edge platforms
  - [Cloud deployment decisions](/en/docs/cloud): Decide whether Bun is the runtime, build tool, or package manager on the target platform
  - [Production engineering baseline](/en/docs/cloud/production-baseline): A TypeScript, CI, supply-chain, environment, and release baseline for Bun services
  - [Containers & Kubernetes](/en/docs/cloud/containers): Reproducible images, probes, signals, secrets, and scaling for Bun services
  - [Serverless & edge](/en/docs/cloud/serverless): Understand Bun's runtime boundaries on Lambda, Vercel, Cloud Run, and Workers
  - [Deploy to AWS Lambda](/en/docs/cloud/deploy-aws-lambda): Run a standard Bun HTTP service on Lambda via a container image and the Lambda Web Adapter
  - [Deploy to Vercel](/en/docs/cloud/deploy-vercel): Run Vercel Functions on Bun via bunVersion, with Next.js steps and runtime differences
  - [Deploy to Cloudflare Workers](/en/docs/cloud/deploy-cloudflare-workers): Use Bun as the package manager and local toolchain for Workers while respecting the workerd runtime boundary

- **AI / Agents**
- For AI / Agents: Dense, low-ambiguity machine-readable context
  - [AI / Agent entry point](/en/docs/ai): Complete Bun tasks accurately with the smallest useful context
  - [Build AI apps with Bun](/en/docs/ai/building-ai-apps): Bun practices for streaming, tool calls, RAG, safety, cost, and production observability
  - [Vibe coding workflow](/en/docs/ai/vibe-coding): Keep coding agents fast in Bun projects while controlling authority, diffs, and verification risk
  - [Paste-ready agent rules](/en/docs/ai/agent-rules): Project-level Bun constraints for Cursor, Claude Code, Codex, and similar agents
  - [Agent task recipes](/en/docs/ai/task-recipes): Minimal operating templates for dependencies, HTTP, subprocesses, files, and migration probes

- **Migration & reference**
- Migration
  - [Migrate from Node.js](/en/docs/migration/from-node): Move an existing Node.js project to Bun in reversible, verifiable stages
- Reference
  - [CLI and configuration](/en/docs/reference/cli-and-config): Common Bun commands, configuration files, environment inputs, and diagnostic order
  - [Compare with Node.js and Deno](/en/docs/reference/compare-runtimes): Choose a runtime by engine, TypeScript support, package management, permission model, and deployment shape
  - [Bun version feature matrix](/en/docs/reference/version-matrix): The Bun version that introduced each commonly used capability, for upgrade decisions and agent task routing
  - [Common errors](/en/docs/reference/error-codes): Causes and fixes for frequent Bun error messages, grouped by the stage where they occur
  - [Known issues](/en/docs/reference/known-issues): Bun defects and limitations that affect this site's examples, with first-party issue links and review dates
  - [Benchmarking methodology](/en/docs/reference/benchmarking): Measure Bun's startup, throughput, and memory reproducibly without being misled by microbenchmarks
  - [FAQ](/en/docs/reference/faq): Bun production readiness, its relationship with npm, type checking, Windows support, and native addons
  - [Ecosystem decisions](/en/docs/reference/ecosystem-decisions): Choose Bun backend, full-stack, database, and engineering tools by portability, maturity, and production constraints

- **About**
- [About this site](/en/docs/about): Community identity, sources, editorial principles, update policy, and corrections for Bun Docs