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

.npmrc support

Bun loads configuration options from .npmrc files, so you can reuse your existing registry and scope configuration.

Security Scanner API

Bun's package manager can scan packages before installing them, to catch supply chain attacks and known vulnerabilities.

Fullstack dev server

Build fullstack applications with Bun's integrated dev server that bundles frontend assets and handles API routes

On this page

Supported options Set the default registry Set the registry for a specific scope Configure options for a specific registry link-workspace-packages: Control workspace package installation save-exact: Save exact versions ignore-scripts: Skip lifecycle scripts dry-run: Preview changes without installing cache: Configure cache directory ca and cafile: Configure CA certificates omit and include: Control dependency types install-strategy and node-linker: Installation strategy public-hoist-pattern and hoist-pattern: Control hoisting