OpenHarness

(โ˜… 15,464)

"OpenHarness: Open Agent Harness with a Built-in Personal Agent--Ohmo!"

  • .gitignore
  • CHANGELOG.md
  • CONTRIBUTING.md
  • LICENSE
  • pyproject.toml
  • README.md
  • README.zh-CN.md
  • RELEASE_NOTES_v0.1.8.md
  • RELEASE_NOTES_v0.1.9.md

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/HKUDS/OpenHarness

Downloads the entire project code from GitHub to your computer.

cd OpenHarness

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
curl -fsSL https://raw.githubusercontent.com/HKUDS/OpenHarness/main/scripts/install.sh | bash

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

pip install openharness-ai

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f src/openharness/sandbox/Dockerfile -t openharness .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 openharness

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd autopilot-dashboard

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install openharness-ai

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation