Get Started

Welcome to Bun Installation Quickstart TypeScript TypeScript 6 and 7

Watch Mode Debugging REPL bunfig.toml File Types Module Resolution JSX Auto-install Plugins File System Router

Cookies File I/O Streams Binary Data Archive SQL SQLite S3 Redis Workers Environment Variables Shell Spawn WebView Cron Node-API FFI C Compiler Transpiler CSRF Protection Secrets Console TOML YAML Markdown JSON5 JSONL HTMLRewriter Image Hashing Glob Semver Color Utils Globals Bun APIs Web APIs Node.js Compatibility

Install TypeScript declarations for Bun Re-map import paths Debugging Bun with the VS Code extension Debugging Bun with the web debugger Inspect memory usage using V8 heap snapshots Build-time constants with --define Define and replace static globals & constants Install and run Bun in GitHub Actions Codesign a single-file JavaScript executable on macOS

File SystemRuntime & Debugging

Re-map import paths

Bun reads the paths field in your tsconfig.json to re-write import paths. This is useful for aliasing package names or avoiding long relative paths.

Install TypeScript declarations for Bun

To add TypeScript definitions for Bun's built-in APIs to your project, install @types/bun .

Debugging Bun with the VS Code extension

Bun speaks the WebKit Inspector Protocol , so you can debug your code with an interactive debugger.