Installation

Requirements

• Node.js >= 18.20.5
• pnpm 9.x (root packageManager: pnpm@9.15.4)

Monorepo (development)

git clone <your-fork-or-upstream>
cd idebug
pnpm install
pnpm build:packages

Workspace packages:

apps/client and apps/server are empty placeholders (not product surfaces yet).

Docs site

pnpm docs:dev
# or: pnpm --filter @idebug/docs dev
# http://localhost:4000

Init CLI (recommended for consumer apps)

From the monorepo root (or via node path/to/idebug/bin/idebug.mjs):

pnpm idebug init
# non-interactive:
pnpm idebug init -p express --app-name my-api --yes
pnpm idebug projects
pnpm idebug status

The CLI prompts for express | nest | react, installs the matching SDK, writes idebug.config.json (canonical setup record), and scaffolds idebug/setup.ts.

See the monorepo root README for full flags.

Consumer apps (manual)

Until packages are published to npm, consume via workspace or path/workspace protocol:

{
  "dependencies": {
    "@idebug/node": "workspace:*",
    "@idebug/ui": "workspace:*"
  }
}

Or relative path:

{
  "dependencies": {
    "@idebug/node": "file:../idebug/packages/node"
  }
}

Always build @idebug/ui so dist/ exists — the Express/Nest SDKs resolve static assets via:

require.resolve('@idebug/ui/package.json'); // → …/dist

If dist is missing, the JSON/SSE API still works; the SPA returns 503 with a clear error body.

Peer / runtime dependencies