Getting Started

Install

npm install @aip-tech/braid

Write a config

braid.config.ts, next to your package.json:

import { defineConfig } from "@aip-tech/braid";

export default defineConfig({
	processes: [
		{ name: "api", command: "pnpm", args: ["--filter", "./api", "run", "dev"], watch: ["api/src"] },
		{ name: "client", command: "pnpm", args: ["--filter", "./client", "run", "dev"] },
	],
});

defineConfig gives you full editor autocomplete and fills in a couple of defaults (like logs.maxSizeBytes) that don't depend on where the CLI is invoked from. A bare array export also works, treated as { processes: [...] }.

See Config for the full field list — watch, dependsOn, onRestart, beforeRestart, readyPattern, logs, and more.

Run it

npx braid start     # starts every configured process as a background daemon
npx braid status    # list each process's name/pid/alive state
npx braid logs --follow
npx braid stop       # kill everything

Or add a package.json script ("dev": "braid start") once @aip-tech/braid is an installed dependency, and just run pnpm dev. See CLI for every command and flag.

Next

• Config reference — every ProcessConfig field, dependent restarts, readiness, and logs.
• Plugins — using plugins, and building your own.