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

Install dependencies with Bun in GitHub Actions

Use the official setup-bun GitHub Action to install bun in your GitHub Actions runner.

Configure git to diff Bun's lockb lockfile

Bun v1.1.39 introduced bun.lock , a JSONC formatted lockfile. bun.lock is human-readable and git-diffable without configuration, at no cost to performance. In

Run your tests with the Bun test runner

Bun has a built-in test runner with a Jest-like expect API.