diff --git a/README.md b/README.md index 646f532..c4920fc 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,23 @@ -# Hermy HQ +
-**Your own mission control for a self-hosted AI agent.** +Hermy HQ โ€” mission control for your self-hosted Hermes agent + +

Your own mission control for a self-hosted AI agent.

+ +

+ Next.js 16 + React 19 + Prisma + Postgres + Tailwind v4 + Pairs with Hermes +

+ +
Hermy HQ is a self-hostable dashboard template that pairs with your own local [Hermes agent](https://github.com/NousResearch/hermes-agent). The website is your cockpit: dispatch work, review the agent's plans, approve anything with side effects, -browse its memory, and watch it run โ€” all from one place. Your Hermes stays on your +browse its memory, and watch it run, all from one place. Your Hermes stays on your own machine; the website and the agent talk to each other through a shared Postgres database acting as a message bus. @@ -15,15 +27,24 @@ environment variables. --- -## ๐Ÿค– Easiest setup: let your agent do it +> [!IMPORTANT] +> **๐Ÿค– If you are an AI agent reading this repository** +> +> The person who gave you this link wants you to **install Hermy HQ for them**. Do this: +> +> 1. **Clone** this repository to the machine you operate on. +> 2. **Open [`ONBOARDING.md`](./ONBOARDING.md)**, a complete step-by-step installer written for you. +> 3. **Follow it in order**, guiding your human through each step: prerequisites, `.env`, database, local run, Vercel deploy, and the bridge. +> 4. **Pause to ask them for every real secret** (API keys, database URL, OAuth credentials). **Never invent or guess credentials**, and keep every side-effecting action approval-gated. +> +> `ONBOARDING.md` is the full guided install. Start there. -> **Send this repo to your Hermes agent and paste [`ONBOARDING.md`](./ONBOARDING.md).** -> It is a ready-to-use prompt that walks your operator through the entire install -> step by step โ€” prerequisites, `.env`, database, local run, Vercel deploy, and the -> bridge โ€” pausing to ask *you* for each real secret. It never invents credentials, -> and it keeps every side-effecting action approval-gated. +--- -Prefer to do it by hand? The [Quick start](#quick-start) below has you covered. +## ๐Ÿš€ Two ways to install + +- **๐Ÿค– Let your agent do it (easiest).** Send this repo to your Hermes and paste the contents of [`ONBOARDING.md`](./ONBOARDING.md). It onboards you step by step, pausing for each secret. +- **๐Ÿ”ง By hand.** Follow the [Quick start](#quick-start) below. --- diff --git a/public/hermy-hq-banner.svg b/public/hermy-hq-banner.svg new file mode 100644 index 0000000..05f5c0f --- /dev/null +++ b/public/hermy-hq-banner.svg @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Hermy HQ + + + + Mission control for your self-hosted Hermes agent + + + + + + NEXT.JS 16 ยท PRISMA ยท POSTGRES BUS + + + + + + + + + WEBSITE + + + + POSTGRES BUS + + + HERMES + +