bf0e5a82f7
* more tests * update migration.zig * fix up paths * update tests * update tests * test * test * update registry tests * comments * early exit if stream is invalid * dont pass invalid_fd to openFileAtWindows * fix merge * misc crash fix * make this use optional pointers instead of 0xaa * ensure absolute paths are propagated properly * package.json expects forward slash * this assert was invalid * add panic checks * pass bun-remove * more panic checks * test: pass bun-add * querying these hangs outside bun too * fix compile error from merge conflict resolution * use compileError instead of comptime unreachable * tidy * bunx: check for the .exe bin extension * bunx: another route to make cache path if it doesnt exist * install: another case of FolderResolution.getOrPut expecting absolute path * fix a bun install crash * dont print zig stack trace if bun install fails * test: pass bun-link * test: bunx: add more expects * test: bun-install-registry: pass * test: bun-install: pass * test: bun-pm: pass * fix merge main error * fix posix tests * fix last failing test in bun-install.test.ts symlink difference between platforms * bun-install-registry.test.ts fix * bun-run.test.ts: remove stray console log --------- Co-authored-by: Meghan Denny <meghan@bun.sh> Co-authored-by: Meghan Denny <hello@nektro.net> Co-authored-by: Jarred Sumner <jarred@jarredsumner.com>
Bun
Read the docs →
What is Bun?
Bun is under active 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 keep 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).
Linux users — Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1.
Windows users — Bun does not currently provide a native Windows build. We're working on this; progress can be tracked at this issue. In the meantime, use one of the installation methods below for Windows Subsystem for Linux.
# with install script (recommended)
curl -fsSL https://bun.sh/install | bash
# with npm
npm install -g bun
# with Homebrew
brew tap oven-sh/bun
brew install bun
# with Docker
docker pull oven/bun
docker run --rm --init --ulimit memlock=-1:-1 oven/bun
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
Quick links
- Intro
- CLI
- Runtime
- Ecosystem
- 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.