bun-workspaces
A monorepo management tool on top
of native Bun
workspaces
- Works right away, with no boilerplate required 🍔🍴
- Get metadata about your monorepo 🤖
- Run
package.jsonscripts across workspaces 📋 - Run inline Bun Shell scripts in workspaces ⌨️
This tool lets you decide the complexity of how you use it. To get started, all you need is a normal project using Bun's native workspaces feature for nested JavaScript/TypeScript packages.
Think of this as a power suit you can snap onto native workspaces, rather than another monorepo framework.
Start running some CLI commands right away in your repo, or take full advantage of the scripting API and its features.
What's New
Notable recent updates 📦
- More advanced workspace patterns can be used to select workspaces, such as by path.
- It's now possible to include or reference a project's root workspace.
- Configuration updates: Added new project root configuration to set defaults, and JSONC is supported for configuration files.
- The Bun Shell is now used by default to run inline scripts, with the option to use the system shell.
- Increased support for Windows users.
Quick Start
See the CLI Quick Start and API Quick Start for starting examples. See the Glossary for more fundamental concepts.
Installation
Required Bun version: ^1.2.0
You can install the package in your project or simply use bunx bun-workspaces to immediately use the latest version of the CLI. Installation is required to use the API.
# Install to use the API and/or lock your CLI version for your project
bun add --dev bun-workspaces
# Start using the CLI with or without the installation step
bunx bun-workspaces --helpIf you use the CLI frequently, you might consider using a shell alias.
# Add this to .bashrc, .zshrc, or similar
# to make it available by default in your shell
alias bw="bunx bun-workspaces"Examples in these docs will use the alias bw for bunx bun-workspaces for brevity.
bun-workspaces is independent from the Bun project and is not affiliated with or endorsed by Anthropic. This project aims to enhance enhance the experience of Bun for its users.