The project's README from github.com/iamlukethedev/Hermes3D. As one markdown file: README.md.
AN OFFICE FOR YOUR AI TEAM!
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.
2D button in the office toolbar).Hermes3D is the visualization and interaction layer.
Today it can sit on top of:
custom runtime provider for orchestrator-backed stacksIn practical terms, this app gives you:
/office retro-office environment where agents appear as workers moving through a shared 3D world/office/builder surface for editing and publishing office layoutsThis 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.
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.
The current app already includes a substantial Hermes3D surface:
Requirements:
Prerequisite:
TUTORIAL.md.hermes-agent backend with no adapter process, follow docs/hermes-agent-tailscale.md.docs/office-conversation-bridge.md.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.
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:
GET /healthGET /stateGET /registryPOST /v1/chat/completionsThe 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 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.
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.
Hermes3D uses two separate network hops:
/api/gateway/ws.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.
npm run dev.http://localhost:3000.ws://localhost:18789 plus your gateway token.Use any gateway URL your machine can reach.
Recommended with Tailscale:
tailscale serve --yes --bg --https 443 http://127.0.0.1:18789.wss://<gateway-host>.ts.net.Alternative with SSH:
ssh -L 18789:127.0.0.1:18789 user@<gateway-host>.ws://localhost:18789.STUDIO_ACCESS_TOKEN if Studio binds to a public host.HOST=0.0.0.0 (or a specific LAN/Tailscale host).STUDIO_ACCESS_TOKEN before exposing Studio beyond localhost.localhost.Important runtime paths:
~/.hermes/hermes.json~/.hermes/hermes3d/settings.jsonCommon environment variables:
HOST and PORT control the Studio server bind address and port.STUDIO_ACCESS_TOKEN protects Studio when binding to a public host.UPSTREAM_ALLOWLIST restricts which upstream gateway hosts Studio may proxy to. Set this in production.CUSTOM_RUNTIME_ALLOWLIST restricts which hosts /api/runtime/custom may fetch. If unset, it falls back to UPSTREAM_ALLOWLIST.NEXT_PUBLIC_GATEWAY_URL provides the default upstream gateway URL when Studio settings are empty. Note: this is a build-time variable — changes require npm run build to take effect.HERMES3D_GATEWAY_URL and HERMES3D_GATEWAY_TOKEN provide a runtime alternative to NEXT_PUBLIC_GATEWAY_URL that takes effect on server restart without a rebuild.HERMES3D_GATEWAY_ADAPTER_TYPE can pair with HERMES3D_GATEWAY_URL to mark those runtime defaults as hermes, demo, local, hermes3d, or custom.HERMES3D_GATEWAY_URL is not set, Studio can still surface local Hermes or demo adapter defaults from HERMES_ADAPTER_PORT / DEMO_ADAPTER_PORT.HERMES_API_URL points the gateway adapter at the Hermes HTTP API. It defaults to http://localhost:8642.~/.hermes/hermes.json when present.HERMES_STATE_DIR and HERMES_CONFIG_PATH override the default Hermes paths.HERMES_GATEWAY_SSH_TARGET, HERMES_GATEWAY_SSH_USER, HERMES_GATEWAY_SSH_PORT, and HERMES_GATEWAY_SSH_STRICT_HOST_KEY_CHECKING support advanced gateway-host operations over SSH when needed.ELEVENLABS_API_KEY, ELEVENLABS_VOICE_ID, and ELEVENLABS_MODEL_ID enable voice reply integration.See .env.example for the full local development template.
npm run dev starts the Studio dev server.npm run hermes-adapter starts the Hermes WebSocket adapter.npm run demo-gateway starts the built-in mock gateway for demo mode.npm run build builds the production Next.js app.npm run start starts the production server.npm run lint runs ESLint.npm run typecheck runs TypeScript without emitting output.npm run test runs unit tests with Vitest.npm run e2e runs Playwright tests.npm run studio:setup prepares common local Studio prerequisites.npm run smoke:dev-server runs a basic dev-server smoke check.VISION.md: project direction and long-term guardrails.ARCHITECTURE.md: system boundaries, data flow, and major trade-offs.TUTORIAL.md: detailed step-by-step setup for Hermes + Tailscale + Hermes3D.docs/hermes-agent-tailscale.md: connect to a remote hermes-agent over Tailscale with no adapter process.docs/office-conversation-bridge.md: optional plugin that makes the office react to chats you have in the desktop app, TUI, or CLI.docs/multi-agent-beta.md: remote office beta setup, connection modes, and limitations.docs/runtime-profiles.md: saved backend/runtime profiles and the current HTTP runtime seam.CODE_DOCUMENTATION.md: practical code map, extension points, and contributor onboarding order.CONTRIBUTING.md: local workflow, testing, and PR expectations.SUPPORT.md: where to ask for help and how to route reports.ROADMAP.md: near-term priorities and contributor-friendly work areas.docs/pi-chat-streaming.md: gateway runtime streaming and transcript rendering.docs/permissions-sandboxing.md: Studio permissions and gateway-side sandbox behavior.docs/hermes-gateway.md: Hermes adapter setup, capabilities, and current limitations./office) and the Phaser builder (/office/builder) are related but still separate stacks./api/office/voice/transcribe returns 501 Not Implemented, so voice notes must be transcribed by an external provider before they reach the office.SOUNDHERMES currently stores an access token only. Refresh-token handling is not implemented yet, so local Spotify auth may need to be repeated after the token expires.If the UI loads but Connect fails, the problem is usually on the Studio -> Gateway side:
EPROTO or wrong version number usually means wss:// was used against a non-TLS endpoint.INVALID_REQUEST errors mentioning minProtocol or maxProtocol usually mean the gateway is too old for Hermes3D protocol v3. Update the gateway you are connecting to, run the bundled Hermes adapter, or run npm run demo-gateway.401 Studio access token required usually means STUDIO_ACCESS_TOKEN is enabled and the request is missing the expected studio_access cookie./api/runtime/custom returns a blocked-host error in production, set CUSTOM_RUNTIME_ALLOWLIST or include the runtime host in UPSTREAM_ALLOWLIST.studio.gateway_url_missing, studio.gateway_token_missing, studio.upstream_error, and studio.upstream_closed.Marketplace skill installs now use a gateway-native workspace flow and do not require enabling SSH on the user machine.
If you are testing the SOUNDHERMES jukebox locally and Spotify OAuth does not accept your localhost callback, use an ngrok callback bridge:
http://localhost:3000.ngrok for the local Studio server, for example ngrok http 3000.ngrok URL into the ngrok Public URL field.https://<your-ngrok-host>/spotify/callback as the redirect URI.How it works:
localhost, so your normal local office state and agent state remain intact.ngrok callback URL.Current local limitation:
ngrok auth flow when that token expires during local development.If you use other advanced gateway-host operations over SSH:
System Settings -> General -> Sharing -> Remote Login, and make sure the target user is allowed.OpenSSH Server optional feature, start the sshd service, and allow it through the firewall.sshd is installed, running, and reachable from the Studio machine.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.
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.