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

Standards & Compatibility

Plugins

Universal plugin API for extending Bun's runtime and bundler

Auto-install

Bun's automatic package installation feature for standalone script execution

File System Router

Bun provides a fast API for resolving routes against file-system paths

On this page

Lifecycle hooks Reference Usage Plugin lifecycle Namespaces onStart onResolve onLoad .defer()Example: tracking and reporting unused exports Native plugins Creating a native plugin in Rust onBeforeParse