Skip to main content

CLI Reference

The harness CLI is the main operator interface. From a source checkout, run npm run harness -- --help or npm run harness -- <command> --help for the version-specific flags in that checkout.

The current source checkout is the supported release path for these docs. The installed --help output is authoritative when a command or flag changes.

Command overview

CommandUse it for
npm run harness -- initGenerate a current configuration from a named profile.
npm run harness -- doctorCheck paths, prerequisites, and optional service connectivity.
npm run harness -- demoList or dry-run built-in tasks before using a real repository.
npm run harness -- runExecute a bounded task against a repository.
npm run harness -- statusInspect recent or active work.
npm run harness -- reportReview structured results and verification evidence.
npm run harness -- exportExport a completed run's compliance report.
npm run harness -- diffPrint a captured task diff for a run and task.
npm run harness -- validateValidate a task definition before running it.
npm run harness -- approveApprove or reject a pending task.
npm run harness -- cancelCancel queued or active distributed work.
npm run harness -- credentialsManage provider credentials without storing secrets in config.
npm run harness -- modelsInspect and manage the model registry.
npm run harness -- controllerStart the distributed controller server.
npm run harness -- uiStart the local operator UI dashboard.

Safe discovery

Start with commands that do not mutate a repository:

npm run harness -- --help
npm run harness -- doctor --help
npm run harness -- demo --list-tasks
npm run harness -- status --help
npm run harness -- report --help
npm run harness -- credentials --help
npm run harness -- controller --help
npm run harness -- ui --help

Run a bounded task

Keep the task file, repository, and verifier explicit:

npm run harness -- run tasks/example.json --repo ./example-repo

The task should describe the intended change and its exact verification command. Review the report before starting another task.

Offline checks

When model services are not running, validate local configuration and paths:

npm run harness -- doctor --skip-model-endpoint --skip-agent-brain

The diff command requires both a run ID and task ID:

npm run harness -- diff <runId> <taskId>

Flags can change between releases. Treat the installed --help output as the authoritative reference for optional flags.