⚠️ Deprecated Package

bun-workspaces has been deprecated and is now developed as pacwich, which supports Bun, npm, and pnpm workspaces, with a mostly backwards compatible CLI and API. Users can expect little to no disruption beyond the package name change and config file name changes.

A full migration guide covering all differences between the packages is available at https://pacwich.dev/intro/bun-workspaces-migration

Installation docs are available at https://pacwich.dev/intro/getting-started

You can also instruct an LLM agent to read https://pacwich.dev/intro/bun-workspaces-migration/index.md to assist with migration.

Read the launch blog post about the motivations and development strategy.

bun-workspaces will not receive further releases save for critical security patches, if necessary. This website will stay up at least through 2026. Once decommissioned, documentation will be consolidated to the package README.

Concept: Workspace Aliases

Overview

A workspace alias is an alternative name for a workspace that can be used in commands such as run-script.

Aliases are validated to be unique to each workspace and to not clash with other workspaces' package.json names, so that every workspace name or alias is an unambiguous reference.

Example Configuration

Workspace aliases are defined in the workspace configuration.

In the below examples, "myApp" may make a simpler reference to a workspace named "@my-organization/my-application".

{
  "alias": "myApp"
}

A workspace can have multiple aliases:

{
  "alias": [
    "myApp",
    "my-app"
  ]
}