Skip to content
This repository was archived by the owner on Apr 3, 2026. It is now read-only.

QUICKSTART.md

Latest commit

 

History

History
78 lines (61 loc) · 2.45 KB

QUICKSTART.md

File metadata and controls

78 lines (61 loc) · 2.45 KB

🚀 HyperCode V2.0 Quickstart

Goal: Run the entire ecosystem (Agents, API, Dashboard, Observability) in under 2 minutes.

📋 Prerequisites

  • Docker & Docker Compose (Desktop 4.0+)
  • Git
  • Node.js 18+ (Optional, only for local frontend development)

⚡ Steps

1. Clone the Repository

git clone https://github.com/welshDog/HyperCode-V2.0.git
cd HyperCode-V2.0

2. Configure Environment

Set up your environment variables (API keys, Database credentials).

cp .env.example .env
# Edit .env and add your PERPLEXITY_API_KEY / OPENAI_API_KEY

3. Launch the Stack

Start all services including the Agent Swarm, Core API, and Observability stack.

docker compose up -d

4. Verify Services

Check that all 23+ containers are healthy.

docker compose ps

🖥️ Access Interfaces

Service URL Credentials (Default)
Web Terminal http://localhost:3000 N/A
Grafana http://localhost:3001 Set via GF_SECURITY_ADMIN_USER / GF_SECURITY_ADMIN_PASSWORD in .env
Prometheus http://localhost:9090 N/A
API Docs http://localhost:8000/docs N/A
Jaeger http://localhost:16686 N/A

🧭 Ports + Profiles

Some services are always on, while others are opt-in via Docker Compose profiles.

Service Port Profile Notes
Core API 8000 default Always on
Mission Control 8088 default Always on
Healer Agent 8010 default Always on
BROski Terminal 3000 default Always on
Hyper-Mission UI 8099 mission docker compose --profile mission up -d
Hyper-Mission API 5000 mission Internal; UI is the entrypoint
MCP tools - mcp-* Profile-gated; enable as needed
Grafana 3001 default Always on
Prometheus 9090 default Always on

🎮 Run Your First Mission

  1. Open the Web Terminal at http://localhost:3000.
  2. Navigate to the Agents tab.
  3. Select Coder Agent.
  4. Type: "Create a Python script that calculates the Fibonacci sequence."
  5. Watch the agent think, plan, and code in real-time.

🛑 Stop Services

docker compose down

Need help? Check DEPLOYMENT_SUMMARY_ONE_PAGE.md for quick troubleshooting.