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

Lockfile

Bun's lockfile format and configuration

Isolated installs

Strict dependency isolation similar to pnpm's approach

Lifecycle scripts

How Bun handles package lifecycle scripts securely

On this page

Should it be committed to git?Generate a lockfile without installing?Can I opt out?Text-based lockfile Automatic lockfile migration