Hermes3D README

The project's README from github.com/iamlukethedev/Hermes3D. As one markdown file: README.md.

Hermes3D — A 3D Workspace for AI Agents

Hermes3D

AN OFFICE FOR YOUR AI TEAM!

CI status GitHub release Follow on X MIT License

Hermes3D is a 3D virtual office for AI agents you run on your own infrastructure. Instead of watching automation through dashboards and logs, you walk through a live 3D office where your agents collaborate, review code, run standups, ship pull requests, and execute tasks side by side. The Gateway is just the control plane — the product is the office.

If you want a personal, self-hosted workspace that turns your AI workforce into something you can actually see, this is it.

Supported runtimes include: Hermes through the bundled gateway adapter, a direct HTTP custom runtime provider for orchestrator-backed stacks, and a built-in demo gateway for office exploration without a real agent framework.

Repository · Vision · Architecture · Tutorial · Getting Started · Runtime Profiles · Multi-Agent Beta · Contributing · Security

Unofficial project. Hermes3D is an independent, community-driven frontend. It is not affiliated with, endorsed by, or maintained by the teams behind the agent backends it connects to.

Built and maintained by LukeTheDev. Follow on X: @iamlukethedev.

What you can do with Hermes3D

What Hermes3D Is

Hermes3D is the visualization and interaction layer.

Today it can sit on top of:

In practical terms, this app gives you:

This repository does not build the upstream runtimes themselves. It is the frontend, Studio, and adapter/proxy layer that connects to a runtime speaking the Hermes3D gateway protocol.

Why It Exists

AI systems are becoming more capable, but their work is still usually hidden behind logs, terminal output, and dashboards.

Hermes3D exists to make agent systems visible:

For the broader direction of the project, see VISION.md.

What Exists Today

The current app already includes a substantial Hermes3D surface:

Quick Start

Requirements:

Prerequisite:

Run from source:

git clone <your-public-repo-url> hermes3d
cd hermes3d
npm install
cp .env.example .env
npm run dev

Then open http://localhost:3000 and configure the gateway URL and token in Studio. Studio now also persists the selected backend mode (Hermes, Demo, Local, Hermes3D, or Custom) and shows the active backend reported by the connected gateway.

Runtime profiles

If you are integrating an orchestrator-backed runtime through the direct HTTP runtime seam, start your runtime first, then start Hermes3D:

npm run dev

Then open http://localhost:3000, choose Local runtime, Hermes3D runtime, or Custom backend, and point the upstream URL at your runtime boundary. Typical examples:

http://127.0.0.1:7770
http://localhost:3000/api/runtime/custom

Current direct-runtime expectations:

The browser does not call that runtime directly. Hermes3D proxies the custom provider through its own same-origin route at /api/runtime/custom, which avoids browser-side CORS problems and keeps the provider transport separate from the Hermes gateway path.

Hermes adapter

Hermes is the default backend. It is reached through the bundled gateway adapter, which speaks the Hermes3D gateway WebSocket protocol on one side and the Hermes HTTP API (http://localhost:8642 by default) on the other:

npm run hermes-adapter
npm run dev

See docs/hermes-gateway.md for setup details and current scope.

For a local gateway on the same machine, the usual upstream URL is:

ws://localhost:18789

In the connect screen, choose Hermes backend, then connect.

Demo mode

If you only want to see the office and agent interactions without installing Hermes:

npm run demo-gateway
npm run dev

Then connect Studio to:

ws://localhost:18789

This starts a mock local gateway with demo agents, streaming chat, session previews, and office presence. In the connect screen, choose Demo backend, then connect.

How It Connects

Hermes3D uses two separate network hops:

  1. Browser -> Studio over HTTP and a same-origin WebSocket at /api/gateway/ws.
  2. Studio -> the gateway over a second WebSocket opened by the Studio server.

That means ws://localhost:18789 always refers to the gateway reachable from the Studio host, not necessarily from the browser device.

This design keeps gateway settings persisted on the Studio host and lets Studio open the upstream connection server-side. The current UI still loads the configured upstream URL/token into browser memory at runtime, so treat the browser as part of the active trust boundary.

Common Setups

Gateway local, Studio local

  1. Start Studio with npm run dev.
  2. Open http://localhost:3000.
  3. Use ws://localhost:18789 plus your gateway token.

Gateway remote, Studio local

Use any gateway URL your machine can reach.

Recommended with Tailscale:

  1. On the gateway host, run tailscale serve --yes --bg --https 443 http://127.0.0.1:18789.
  2. In Studio, use wss://<gateway-host>.ts.net.

Alternative with SSH:

  1. Run ssh -L 18789:127.0.0.1:18789 user@<gateway-host>.
  2. In Studio, use ws://localhost:18789.

Studio remote, Gateway remote

  1. Run Studio on the remote host.
  2. Expose Studio on a private network or over Tailscale.
  3. Set STUDIO_ACCESS_TOKEN if Studio binds to a public host.
  4. Configure the gateway URL and token inside Studio.

Studio on LAN or Tailscale for other devices

  1. Start Studio with HOST=0.0.0.0 (or a specific LAN/Tailscale host).
  2. Set STUDIO_ACCESS_TOKEN before exposing Studio beyond localhost.
  3. Open Hermes3D from the LAN/Tailscale address instead of localhost.
  4. If you are connecting to a remote gateway, make sure that gateway accepts connections from the Studio host and that the token you configured is the one it expects.

Tech Stack

Configuration

Important runtime paths:

Common environment variables:

See .env.example for the full local development template.

Scripts

Documentation

Current Limitations

Troubleshooting

If the UI loads but Connect fails, the problem is usually on the Studio -> Gateway side:

Marketplace skill installs now use a gateway-native workspace flow and do not require enabling SSH on the user machine.

Spotify auth on localhost

If you are testing the SOUNDHERMES jukebox locally and Spotify OAuth does not accept your localhost callback, use an ngrok callback bridge:

  1. Keep Hermes3D running locally on http://localhost:3000.
  2. Start ngrok for the local Studio server, for example ngrok http 3000.
  3. In the jukebox setup UI, paste your public ngrok URL into the ngrok Public URL field.
  4. In the Spotify developer dashboard, register https://<your-ngrok-host>/spotify/callback as the redirect URI.
  5. Complete Spotify sign-in from the jukebox panel.

How it works:

Current local limitation:

If you use other advanced gateway-host operations over SSH:

For first-time SSH connections, Hermes3D uses StrictHostKeyChecking=accept-new by default so a new host key can be trusted automatically. If you need stricter behavior, set HERMES_GATEWAY_SSH_STRICT_HOST_KEY_CHECKING=yes, or set it to no only if you explicitly want to skip host key checks.

Contributing

Keep pull requests focused, run npm run lint, npm run typecheck, and npm run test before opening a PR, and update docs when behavior or architecture changes.

Shared editing expectations for this repository are described in CONTRIBUTING.md and AGENTS.md, including the boundary between Hermes3D and the backend it connects to, code placement conventions, office-stack distinctions, and documentation/test update expectations.

Community expectations live in CODE_OF_CONDUCT.MD. Security reporting instructions live in SECURITY.md.

Hermes3D (iamlukethedev/Hermes3D)

Searching Database…

What is this?Hermes3D is a self-hosted 3D virtual office where you can watch your AI agents work in real time, as they collaborate, review code, run standups, and ship pull requests, instead of reading logs and dashboards.
Is this the AI agent engine itself, or just a frontend for one?It is purely the visualization and interaction layer - a Next.js/Three.js frontend, Studio server, and gateway/proxy that connects to a runtime like Hermes, a custom HTTP-based orchestrator, or a built-in demo gateway; it does not build or run the agents itself.
How do I get it running?Clone the repo and run 'npm run dev' to start the Studio server, then open it in a browser and point it at a gateway URL and token; for a no-backend look at the office, run 'npm run demo-gateway' instead.
Do I need a Hermes server running first?Yes, for the real backend mode - Hermes3D does not install or build Hermes for you, so you need a running Hermes API server plus the bundled gateway adapter (or your own custom HTTP runtime). Node.js 20+ and npm 10+ are needed to run Studio itself.
What should I watch out for before connecting to a remote gateway?The browser loads your configured gateway URL and token into memory at runtime, so the browser is part of the trust boundary; for anything beyond localhost you need to set STUDIO_ACCESS_TOKEN and restrict UPSTREAM_ALLOWLIST.
Can I run Studio and the gateway on different machines?Yes - Studio and the gateway are two separate network hops (browser-to-Studio, Studio-to-gateway), so you can run them on different hosts and bridge them with Tailscale or an SSH tunnel for remote setups.
What can agents actually do inside the 3D office?Agents can be managed as a fleet, chatted with, run standups connected to GitHub and Jira, review pull requests, monitor QA pipelines and logs, and train new skills in a 'gym' - all from inside the shared office.
Is there a lighter-weight view for low-power machines?Yes, a Gather-style 2D pixel-art office view of the same live agents can be toggled from Settings or the office toolbar instead of the full 3D scene.
Which agent runtimes does it support?Hermes via the bundled WebSocket gateway adapter, any orchestrator exposing a direct HTTP runtime (health/state/registry/chat endpoints), or the built-in demo gateway that needs no real backend.
Can it react to chats from my existing CLI or desktop agent setup?Yes, via an optional office-conversation-bridge plugin described in the docs, which makes the 3D office react to chats you already have elsewhere, like a desktop app, TUI, or CLI.
Size
6.9 MB
Stars
594
Age
2mo
Commits · 90 Days