Worker Repository Management (worker-cli)

worker-cli is the operational SDK surface for managing a FlowMaker worker repository end-to-end: bootstrap, scaffold workers, validate repository health, build images, test registration, and release.

Summary

This section guides you through the full worker lifecycle: initialize a repo, create workers, implement logic in src/, implement config UI in frontend/, validate consistency/versioning, and build/test release images.

Worker guidelines to keep in mind:

  • Keep worker root structure compact (max 15 files/directories at worker root)
  • Keep implementation code under src/
  • Always include at least one README*.md in each worker directory

Start here

Mental model

A worker repository has one job: keep each worker buildable, testable, versioned, and releasable.

initstepsBootstrap repo structure;Verify prerequisitesApply guidelinescreatestepsScaffold workersDefine IO interfacesSet registration metadataeditstepsImplement logicBuild config UIAdd README docsconsistency + checkchecksVersion validationID format checkIO contract verifybuildstepsCompile workersBuild Docker imagesValidate registrationpushreleasePush to registryTag releasesDeploy to runtime

[NOTE!lightbulb/ROLE BOUNDARIES] worker-cli manages repository operations and release confidence. Your worker code stays your responsibility (src/ logic + frontend/ config UI).

Public command map

npx worker-cli init
npx worker-cli update-repo-guidelines
npx worker-cli create [--type --name --box-type --icon ...]
npx worker-cli consistency [worker1 worker2 ...]
npx worker-cli check
npx worker-cli build [-i|--interactive] [--push] [--test|--no-test] [--no-check] [--no-proxy] [--parallel[=N]] [worker-name]
npx worker-cli test <worker-dir> <image-name>
npx worker-cli doctor

References

  • sdk/worker/repo-management/README.md
  • sdk/worker/repo-management/src/worker-cli.ts
  • sdk/worker/repo-management/src/commands/