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

Add a dependency Add a development dependency Add an optional dependency Add a peer dependency Add a Git dependency Add a tarball dependency Install a package under a different name Configuring a monorepo using workspaces Override the default npm registry for bun install Configure a private registry for an organization scope with bun install Using bun install with an Azure Artifacts npm registry Using bun install with Artifactory Add a trusted dependency Generate a yarn-compatible lockfile Migrate from npm install to bun install Configure git to diff Bun's lockb lockfile Install dependencies with Bun in GitHub Actions

File SystemPackage Manager

Add a dependency

To add an npm package as a dependency, use bun add .

Enable compression for WebSocket messages

Set the perMessageDeflate parameter to compress all messages with the permessage-deflate WebSocket extension.

Add a development dependency

To add an npm package as a development dependency, use bun add --development .