Setup, Prerequisites, and Doctor Checks

Required tooling

Tool Required for
Node.js CLI runtime
Docker Building and testing worker images
Docker buildx Multi-arch build workflows
pnpm Node workers and generated frontends
Python 3 Python workers
dotnet SDK .NET workers

Validate machine readiness

npx worker-cli doctor

doctor checks required commands and reports missing prerequisites with install pointers.

Environment variables you should know

Variable Purpose
REGISTRY Base registry used to form image names during build
IMAGE_PREFIX Optional segment between registry and worker name
CONFIG_HUB_MOCK_PORT Port used by mock hub during container tests
MOCK_HUB_HOST_IP / DOCKER_HOST_IP Host address containers use to call the mock hub
TIMEOUT Registration wait timeout (seconds) for test
FLOWMAKER_WORKERS_ROOT Optional override for root discovery

Example .env:

REGISTRY=registry.example.com
IMAGE_PREFIX=myteam/
CONFIG_HUB_MOCK_PORT=3120
TIMEOUT=45

Root discovery behavior

worker-cli resolves the target repository by searching upward for workers/.

current dir
   |
   +-- has workers/? -> yes: use it
   |
   +-- no -> parent -> parent -> ...
   |
   +-- none found -> fallback root

[NOTE!lightbulb/ROLE BOUNDARIES] Use FLOWMAKER_WORKERS_ROOT when automating from CI scripts that run outside the worker repository tree.

Practical setup patterns

Single-machine local dev

npx worker-cli doctor
npx worker-cli consistency

CI preflight

npx worker-cli doctor
npx worker-cli consistency
npx worker-cli check

References

  • sdk/worker/repo-management/src/commands/doctor.ts
  • sdk/worker/repo-management/src/lib/context.ts