# Bun Docs（中文）

> 面向人类新手与 AI Agent 的任务型 Bun 文档索引。

# Bun 实用文档

> 面向新手与 AI Agent 的 Bun 任务型文档

- [Bun 实用文档](/docs): 面向新手与 AI Agent 的双语、任务型 Bun 知识库

- **开始使用**
- 开始使用: 从安装到第一个可测试服务
  - [5 分钟上手](/docs/getting-started/quickstart): 安装 Bun，创建一个 TypeScript HTTP 服务并运行测试
  - [先建立心智模型](/docs/getting-started/mental-model): 用 Node.js 开发经验理解 Bun 的四个角色和边界

- **核心工具链**
- 核心工具链: 运行、安装、Monorepo、测试、打包与数据访问
  - [运行时](/docs/core/runtime): 运行 TypeScript、执行脚本、读取环境变量并启动 HTTP 服务
  - [WebSocket 与实时功能](/docs/core/websockets): 用 Bun.serve 原生 WebSocket 实现连接管理、pub/sub、背压与保活
  - [包管理器](/docs/core/package-manager): 用 bun install 管理依赖、锁文件、工作区和 CI 安装
  - [Monorepo 与 Workspaces](/docs/core/monorepo): 使用 Bun Workspaces、Catalogs、isolated linker 和过滤命令维护可复现 Monorepo
  - [测试运行器](/docs/core/test-runner): 使用 bun:test 编写测试、模拟依赖并在 CI 中稳定执行
  - [打包器](/docs/core/bundler): 使用 bun build 为浏览器、Bun 或 Node.js 生成可部署产物
  - [前端开发与 HTML Imports](/docs/core/frontend): 用 Bun 的全栈开发服务器直接运行 HTML、TypeScript 与 CSS，并正确产出生产构建
  - [数据库与存储](/docs/core/data-and-storage): 在 Bun 中选择 Bun.SQL、SQLite、Redis、S3 与 Drizzle，并正确管理连接和生产边界

- **生产部署**
- 云计算与部署: 把 Bun 正确部署到容器、Serverless 与边缘平台
  - [云部署决策](/docs/cloud): 先确认 Bun 在目标平台扮演运行时、构建工具还是包管理器
  - [生产工程基线](/docs/cloud/production-baseline): Bun 服务的 TypeScript、CI、供应链、环境变量和发布门禁基线
  - [容器与 Kubernetes](/docs/cloud/containers): Bun 服务的可复现镜像、探针、信号、密钥和扩缩容基线
  - [Serverless 与边缘](/docs/cloud/serverless): 在 Lambda、Vercel、Cloud Run 与 Workers 上正确理解 Bun 的运行边界
  - [部署到 AWS Lambda](/docs/cloud/deploy-aws-lambda): 用容器镜像 + Lambda Web Adapter 让标准 Bun HTTP 服务接 Lambda 事件
  - [部署到 Vercel](/docs/cloud/deploy-vercel): 用 bunVersion 让 Vercel Functions 以 Bun 运行，并处理 Next.js 与边界差异
  - [部署到 Cloudflare Workers](/docs/cloud/deploy-cloudflare-workers): 用 Bun 做 Workers 的包管理与本地工具链，理解线上运行时 workerd 的边界

- **AI / Agent**
- 给 AI / Agent: 高密度、低歧义的机器可读上下文
  - [AI / Agent 入口](/docs/ai): 用最少上下文安全、准确地完成 Bun 任务
  - [用 Bun 构建 AI 应用](/docs/ai/building-ai-apps): 流式输出、工具调用、RAG、安全、成本与生产观测的 Bun 实践
  - [Vibe coding 工作流](/docs/ai/vibe-coding): 让编码 Agent 在 Bun 项目里保持速度，同时控制权限、差异和验证风险
  - [可复制的 Agent 规则](/docs/ai/agent-rules): 为 Cursor、Claude Code、Codex 等编码 Agent 提供项目级 Bun 约束
  - [Agent 任务配方](/docs/ai/task-recipes): 安装依赖、创建服务、编写测试和迁移项目的最小操作模板

- **迁移与参考**
- 迁移
  - [从 Node.js 迁移](/docs/migration/from-node): 以可回滚、可验证的阶段把现有 Node.js 项目迁到 Bun
- 参考
  - [CLI 与配置速查](/docs/reference/cli-and-config): Bun 常用命令、配置文件、环境变量和排错顺序
  - [与 Node.js、Deno 对比](/docs/reference/compare-runtimes): 从引擎、TypeScript、包管理、权限模型和部署形态选择运行时
  - [Bun 版本特性矩阵](/docs/reference/version-matrix): 常用能力首次出现的 Bun 版本，用于升级决策与 Agent 任务路由
  - [常见报错对照](/docs/reference/error-codes): Bun 高频错误信息的原因与处理路径，按发生阶段分组
  - [已知问题速查](/docs/reference/known-issues): 影响本站示例的 Bun 已知缺陷与限制，按核验日期排序并附一手 issue
  - [性能测量方法论](/docs/reference/benchmarking): 用可复现的方法评估 Bun 的启动、吞吐与内存，不被微基准误导
  - [常见问题](/docs/reference/faq): Bun 生产可用性、与 npm 的关系、类型检查、Windows 支持与原生扩展
  - [生态选型决策](/docs/reference/ecosystem-decisions): 按可移植性、成熟度和生产约束选择 Bun 后端、全栈、数据库与工程工具

- **关于**
- [关于本站](/docs/about): Bun Docs 的社区身份、资料来源、编辑原则、更新策略与纠错方式