monoboard
v0.1.0
Published
A local dashboard for running and observing pnpm monorepo packages.
Maintainers
Readme
MonoBoard
MonoBoard is a local dashboard for pnpm monorepos. It installs into an isolated .monoboard/ folder inside your existing repository, scans workspaces, runs package scripts, and streams terminal output back to the browser.
Status
MonoBoard is in early MVP development. The current version supports:
- pnpm workspace discovery from
pnpm-workspace.yaml - package script execution from the browser
- live stdout/stderr streaming over WebSocket
- one-click Cloudflare Workers deploys for buildable workspaces
- an isolated
.monoboard/install that keeps MonoBoard files separate from app code
Requirements
- Node.js 22.12 or newer
- pnpm 10.15 or newer
- A target repository with
pnpm-workspace.yaml
Install Into A Monorepo
From this source checkout during local development:
cd /path/to/your/monorepo
pnpm --dir /path/to/monoboard init:monoboardYou can also pass the target repo explicitly:
cd /path/to/monoboard
pnpm init:monoboard /path/to/your/monorepoThe installer creates:
.monoboard/
app/
monoboard.config.json
start.shMonoBoard does not edit your apps, packages, or root package.json.
Start
From your monorepo:
./.monoboard/start.shThe script installs MonoBoard dependencies inside .monoboard/app when needed, builds the UI once, then starts the backend. The backend serves the API, WebSocket, and the built UI all on a single port.
Open http://127.0.0.1:1709 in your browser. MonoBoard listens on the local machine only by default, because it can run workspace scripts and deployments.
You can also start via the CLI (after monoboard init):
monoboard startInstall with pnpm
Once MonoBoard is published to npm, use pnpm without a global installation:
cd /path/to/your/monorepo
pnpm dlx monoboard init
./.monoboard/start.shThis is the recommended install flow. You can also add it to a repository as a
development dependency with pnpm add -D monoboard, then run
pnpm exec monoboard init.
The local source command above mirrors the published-package flow.
Development
Install dependencies for this repository:
pnpm install
pnpm --dir ui installRun the backend against the current directory or a target repo:
pnpm dev:backend
MONOBOARD_TARGET_REPO=/path/to/your/monorepo pnpm dev:backendRun the UI (dev mode with hot reload, proxies /api and /ws to the backend on 1709):
pnpm dev:uiProduction single-port mode (builds the UI, then serves everything on http://127.0.0.1:1709):
pnpm build
pnpm startChecks
pnpm test
pnpm typecheck
pnpm lint:ui
pnpm build:uiOne-Click Deploy
MonoBoard shows a Deploy button for workspaces that have a build script. The first deploy target is Cloudflare Workers.
Default behavior:
- builds the workspace with
pnpm --dir <workspace> run build - detects the project stack and runs its supported build/deploy flow
- uses the package name as the default Cloudflare Worker name
- publishes to
https://<project>.workers.dev
You can override the deploy target in a workspace package.json:
{
"name": "@acme/site",
"scripts": {
"build": "next build"
},
"monoboard": {
"deploy": {
"provider": "cloudflare-workers",
"projectName": "acme-site",
"outputDir": "out"
}
}
}Before deploying, log in to Cloudflare once on the same machine:
pnpm dlx wrangler loginThe deploy log streams into the MonoBoard terminal panel.
Security
MonoBoard is a local development tool and can run scripts declared by your
workspace packages. It binds to 127.0.0.1 by default and does not enable
cross-origin API access. Do not expose it to a network unless you place it
behind authentication and intentionally set MONOBOARD_HOST.
API
GET /api/healthGET /api/workspacesGET /api/runsPOST /api/scripts/runPOST /api/deployments/runPOST /api/runs/:runId/stop
WebSocket clients connect to the backend root and receive run events:
runs:snapshotrun:startedrun:outputrun:status
License
ISC
