Bun

Documentation   •   Discord   •   Issues   •   Roadmap

Read the docs →

What is Bun?

​​Bun is still under development. Use it to speed up your development workflows or run simpler production code in resource-constrained environments like serverless functions. We're working on more complete Node.js compatibility and integration with existing frameworks. Join the Discord and watch the GitHub repository to keeps tabs on future releases.

Bun is an all-in-one toolkit for JavaScript and TypeScript apps. It ships as a single executable called bun​.

At its core is the Bun runtime, a fast JavaScript runtime designed as a drop-in replacement for Node.js. It's written in Zig and powered by JavaScriptCore under the hood, dramatically reducing startup times and memory usage.

bun run index.tsx             # TS and JSX supported out of the box

​​The bun​ command-line tool also implements a test runner, script runner, and Node.js-compatible package manager. Instead of 1,000 node_modules for development, you only need bun. Bun's built-in tools are significantly faster than existing options and usable in existing Node.js projects with little to no changes.

bun test                      # run tests
bun run start                 # run the `start` script in `package.json`
bun install <pkg>​             # install a package
bunx cowsay "Hello, world!"   # execute a package

Install

Bun supports Linux (x64 & arm64) and macOS (x64 & Apple Silicon). If you want to use Bun on Windows, you will need to use Windows Subsystem for Linux. Bun will soon support Windows, natively.

curl

curl -fsSL https://bun.sh/install | bash

npm

npm install -g bun

brew

brew tap oven-sh/bun
brew install bun

docker

docker pull oven/bun
docker run --rm --init --ulimit memlock=-1:-1 oven/bun

If using Linux, kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1.

Upgrade

To upgrade to the latest version of Bun, run:

bun upgrade

Bun automatically releases a canary build on every commit to main. To upgrade to the latest canary build, run:

bun upgrade --canary

View canary build

Quick links

• Intro
  • What is Bun?
  • Installation
  • Quickstart
• CLI
  • bun run
  • bun install
  • bun test
  • bun create
  • bunx
• Runtime
  • Runtime
  • Module resolution
  • Hot reloading
  • Plugins
• Ecosystem
  • Node.js
  • TypeScript
  • React
  • Express
• API
  • HTTP
  • WebSockets
  • TCP Sockets
  • File I/O
  • SQLite
  • FileSystemRouter
  • Globals
  • Spawn
  • Transpiler
  • Console
  • FFI
  • HTMLRewriter
  • Testing
  • Utils
  • DNS
  • Node-API

Contributing

Refer to the Project > Contributing guide to start contributing to Bun.

License

Refer to the Project > License page for information about Bun's licensing.