workblock-factory
v0.2.0
Published
Workblock runtime CLI: install, run, upgrade, diagnose, and repair the Beyond Work local developer and agent stack. Supersedes the 0.1.x .mjs-based installer.
Readme
workblock-factory
Workblock runtime CLI: install, run, upgrade, diagnose, and repair the Beyond Work local developer and agent stack — the platform bridge, the VS Code / Cursor extension, the headless Claude Code / Codex bridge, the local sandbox runtime, digest-pinned Docker images, and versioned knowledge bundles — from one npm-installed command.
Install
npm install -g workblock-factoryRequires Node >= 22.5. The docker and fidelity sandbox modes additionally
need Docker with Compose v2 and Docker Hub access to the private autoswarm/*
images.
Quickstart
# Claude Code user without VS Code: headless bridge + docker sandbox.
workblock setup --profile claude --bridge headless --sandbox docker
# Verify everything (add --deep for network dials and service probes).
workblock --health
# Launch Claude Code with the Beyond Work MCP config and bridge preflight.
bw-claudeState lives under .bw-sandbox/ in your workspace root; inspect it with
workblock status, workblock config get, and workblock doctor.
Binaries
| Bin | Purpose |
| --- | --- |
| workblock | Runtime CLI: setup, status, health, upgrade, doctor, bridge, platform, sandbox, agents, vscode, knowledge, images, config, version |
| workblock-factory | Alias for workblock (continuity with the 0.1.x installer) |
| bw-claude | Launch Claude Code with generated BW config and a live bridge |
| bw-codex | Launch Codex with a generated BW profile and a live bridge |
| beyondwork-agent | MCP stdio server bridging agents to the Workblock bridge |
Top-level aliases: workblock --health, workblock --upgrade,
workblock --bridge-restart.
Documentation
Source and docs: https://github.com/chllming/workblock-factory
- Full command reference: docs/workblock-cli.md
- Generated MCP tool/policy tables: docs/workblock-tools.generated.md
Development
From packages/workblock-cli in the repository:
pnpm test # vitest suite
pnpm check-types # tsc --noEmit
pnpm build # esbuild bundles into dist/ (CJS, one file per bin)
pnpm dev -- --help # run the CLI from source via tsxThe canonical MCP tool registry lives in the sibling
@beyondwork/workblock-bridge-core package (synced from the private Beyond
Work monorepo); after a registry sync, run pnpm generate there to refresh
the generated docs table, or the registry drift tests will fail.
