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

bunx Workspaces Catalogs bun --filter Global cache Global virtual store Isolated installs Lockfile Lifecycle scripts Scopes and registries Overrides and resolutions Security Scanner API .npmrc support

Advanced Configuration

bunx

Run packages from npm

bun info

Display package metadata from the npm registry

Workspaces

Develop complex monorepos with multiple independent packages

On this page

Arguments and flags Shebangs Package flag Usage Flags Examples