Ever feel like handing a raw Business Requirement Document (BRD) to your AI coding assistant results in a chaotic mess? ๐ While GitHub Copilot is absolute magic at writing code, throwing massive, unstructured requirements at it can lead to missed context, sloppy architecture, and endless debugging loops.
Enter OpenHarness ๐ฆ—the multi-agent framework designed to take your high-level ideas, slice them up with specialized AI personas, and generate crystal-clear documentation before a single line of code is written.
Here’s your step-by-step guide to setting up OpenHarness on Windows and why pairing it with GitHub Copilot is a complete game-changer. ๐
๐ ️ Step-by-Step OpenHarness Setup (Windows Edition)
Step 1: Clone the Repository ๐
First, grab the official repository to get all the underlying scripts and configurations.
git clone https://github.com/HKUDS/OpenHarness
Step 2: Installation ⚡
Because we’re on Windows, you can kick off a slick one-click installation via PowerShell:
# One-click install (PowerShell)iex (Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/HKUDS/OpenHarness/main/scripts/install.ps1')
Alternatively, if you prefer using pip:
pip install openharness-ai
Step 3: Locate Your Virtual Environment ๐
Once installed, OpenHarness automatically creates an isolated virtual environment inside your user folder:
C:\Users\<YourUserName>\.openharness-venv
Step 4: Activate the Environment ๐
Open your favorite terminal (Command Prompt, PowerShell, or VS Code terminal), navigate to the script directory, and activate the virtual environment:
cd C:\Users\<YourUserName>\.openharness-venv\Scripts\.\activate
Step 5: Launch OpenHarness CLI ๐ฅ️
Run the CLI command to make sure everything is fired up and working properly:
openh
You should see the interactive OpenHarness CLI screen ready for action! ๐
Step 6: Connect to GitHub Copilot ๐
Let’s hook up OpenHarness to leverage your GitHub Copilot models. Run:
openh setup
- Select GitHub as your provider.
- The CLI will prompt you to authenticate via your browser.
- Log in with your corporate or personal GitHub account, grant device authorization, and boom—you’re connected to Copilot’s models! ๐
๐️ Generating Complete Architecture & Specs
Now for the fun part: turning a vague requirement into clean, actionable project documentation.
1️⃣ The Business Analysis Pass ๐
Feed your BRD into OpenHarness and prompt it to parse out the critical domain specifics:
Prompt Goal:
Identify: Actors, Functional & Non-Functional Requirements, Integrations, Security, and Reporting.
Generate: Epics, Features, and User Stories.
Output: BRD Summary, Feature List, User Story Backlog, and Acceptance Criteria.
2️⃣ The Architecture & Design Pass ๐️
Next, tell OpenHarness to construct the complete technical blueprint based on your tech stack:
Tech Stack:
๐น Frontend: Angular
๐น Backend: Spring Boot
๐น Database: Oracle
๐น Security: LDAP + OAuth2
๐น Deployment: OpenShift
Generate: HLD (High-Level Design), LLD (Low-Level Design), Sequence Diagrams, Module Designs, and API Inventories.
Output Folder:/architecture
Once OpenHarness dumps these crisp Markdown (.md) spec files into your project, point GitHub Copilot at the documentation and ask it to write the code. Copilot will perform infinitely better because it now has full context! ๐ฏ
๐ค Why OpenHarness + GitHub Copilot?
If GitHub Copilot already writes code, why do you need OpenHarness?
Think of GitHub Copilot as a master developer, and OpenHarness as the entire engineering department. When you have complex systems, a single prompt isn’t enough. OpenHarness orchestrates specialized AI Agents, each focusing on a distinct phase of the software development lifecycle:
| Agent Role ๐ค | Core Responsibility ๐ |
|---|---|
| Business Analyst Agent | BRD Summaries & Domain Mapping |
| Product Owner Agent | Features & User Stories |
| Architect Agent | HLD, LLD & Tech Stack Alignments |
| Design / API Agent | Swagger / OpenAPI Contracts & Diagrams |
| Developer Agent | Code Generation & Scaffolding |
| Testing / QA Agent | Test Cases & Integration Tests |
| Security Agent | Vulnerability & Architecture Reviews |
๐ก The Recommended Workflow
Instead of making Copilot do all the heavy lifting from scratch, divide and conquer:
๐ Business Requirement Document (BRD) │ ▼ ๐ค OpenHarness Agents ├── ๐ BA Agent ➡️ Generates User Stories & Acceptance Criteria ├── ๐ Architect Agent ➡️ Generates HLD, LLD, & API Contracts │ ▼ ๐ค GitHub Copilot Agent └── ๐ป Dev Agent ➡️ Generates Spring Boot & Angular Code │ ▼ ๐ค OpenHarness Agents ├── ๐งช QA Agent ➡️ Generates Unit & Integration Tests └── ๐ก️ Security Agent ➡️ Conducts Code & Doc Reviews
TL;DR ๐
- Use OpenHarness to generate well-structured
.mddocumentation, architecture blueprints, and user stories. - Feed those
.mddocs into GitHub Copilot to write production-grade code.
Happy coding! ๐✨









