Skip to main content

Install

Agent Harness currently runs from a source checkout or as the Docker Compose controller-plus-workers stack. The repository uses npm for dependency installation and CLI scripts; the public npm registry package is not the current release path.

◆Current supported install paths

The verified CLI flow uses Node.js 20.x from a source checkout. Docker is optional for the local CLI and required only for the Compose deployment path. Native downloads appear on the Download page only when a platform build is available.

Prerequisites

  • Node.js 20.x (the package currently declares >=20 <21)
  • Git for the source-checkout path
  • Docker Desktop or Docker Engine with Compose for the container workflow

Source checkout

git clone https://github.com/joshl26/agentharness.git
cd agent-harness
npm install
npm run build
npm run harness -- --help

Run the CLI from this checkout with npm run harness -- <command>.

Docker Compose

From a source checkout, use Compose when you want the controller, workers, and operator UI in a repeatable containerized environment:

docker compose up --build

The default operator UI is at http://localhost:7000 and the controller is at http://localhost:5001. Set OLLAMA_ENDPOINT at invocation time when the model server is published on a different host or port. The Compose file and bundled example fixtures are part of the source checkout, not the npm package.

Keep model endpoints and credentials in your local environment or secret manager. Do not commit them to a Compose file.

After installation

Once installation completes, run commands through the source checkout's npm script: npm run harness -- <command>.

Verify your setup:

npm run harness -- doctor

Generate a config for your first task:

npm run harness -- init --profile local

✦Offline validation

If you are validating config shape and local paths before model or Brain services are available, run npm run harness -- doctor --skip-model-endpoint --skip-agent-brain.