Skip to content

Open-source platform for 3D AI agents. Turn text or a photo into a rigged, animated GLB avatar, give it an LLM brain, memory and a wallet, and embed it anywhere with one web component. Remote MCP server, x402 payments, Three.js, browser-native.

fix(hq): point apps/hq's contributor, roadmap and env-example links at real files

nirholas35a1798385b5
diff --git a/apps/hq/.env.example b/apps/hq/.env.example
new file mode 100644
index 000000000..0dd1e80db
--- /dev/null
+++ b/apps/hq/.env.example
@@ -0,0 +1,71 @@
+# ────────────────────────────────────────────────────────────────────────────
+# HQ - environment variables
+# Copy to .env.local for local dev. The dashboard works with zero configuration;
+# every var below only unlocks an optional lane or integration. Production sets
+# these on the Cloud Run service (see docs/deploy-cloud-run.md).
+# ────────────────────────────────────────────────────────────────────────────
+
+# AI summaries (morning briefing, AI-powered analysis). Falls back to the
+# browser ML lane (ONNX Runtime, offline) when unset.
+GROQ_API_KEY=
+OPENROUTER_API_KEY=
+
+# Shared cache (Upstash Redis). Without these, each API route falls back to
+# an in-process cache that does not survive a cold start.
+UPSTASH_REDIS_REST_URL=
+UPSTASH_REDIS_REST_TOKEN=
+
+# Stocks (Finnhub)
+FINNHUB_API_KEY=
+
+# World events (ACLED conflict data)
+ACLED_ACCESS_TOKEN=
+
+# World events (UCDP conflict data)
+UCDP_ACCESS_TOKEN=
+
+# Wildfire detection (NASA FIRMS)
+FIRMS_API_KEY=
+NASA_FIRMS_API_KEY=
+
+# Macro data (FRED, EIA)
+FRED_API_KEY=
+EIA_API_KEY=
+
+# On-chain explorers (gas tracker, wallet tracker)
+ETHERSCAN_API_KEY=
+ARBISCAN_API_KEY=
+BSCSCAN_API_KEY=
+THEGRAPH_API_KEY=
+
+# Threat intelligence (exploit alerts and ledger)
+ABUSEIPDB_API_KEY=
+OTX_API_KEY=
+URLHAUS_AUTH_KEY=
+
+# Military aircraft tracking (OpenSky OAuth2, relay via WINGBITS)
+OPENSKY_CLIENT_ID=
+OPENSKY_CLIENT_SECRET=
+WINGBITS_API_KEY=
+
+# Vessel tracking (AISStream)
+AISSTREAM_API_KEY=
+VITE_AISSTREAM_API_KEY=
+AIS_SNAPSHOT_INTERVAL_MS=
+
+# Custom domain / CDN purge (Cloudflare)
+CLOUDFLARE_API_TOKEN=
+
+# Local API sidecar (desktop app / local dev only; leave unset in production)
+LOCAL_API_MODE=
+LOCAL_API_PORT=
+LOCAL_API_TOKEN=
+LOCAL_API_REMOTE_BASE=
+LOCAL_API_CLOUD_FALLBACK=
+LOCAL_API_RESOURCE_DIR=
+LOCAL_API_CACHE_PERSIST_MAX=
+CACHE_TELEMETRY_LOG_EVERY=
+WS_RELAY_URL=
+
+# Server port (Cloud Run sets this automatically; default 8080/5173 otherwise)
+PORT=
diff --git a/apps/hq/README.md b/apps/hq/README.md
index 5124d8d6a..974dfb078 100644
--- a/apps/hq/README.md
+++ b/apps/hq/README.md
@@ -47,7 +47,7 @@ npm run test:sidecar # API/sidecar unit tests
- deck.gl 9 + MapLibre GL for the globe, d3 for charts.
- Two build variants: `full` (DeFi command center) and `tech` (AI/startups).
-See [CLAUDE.md](CLAUDE.md) for the contributor guide and [ROADMAP.md](ROADMAP.md) for direction.
+See [AGENTS.md](AGENTS.md) for the contributor guide and [ROADMAP.md](ROADMAP.md) for direction.
## Deployment (Google Cloud Run)
diff --git a/apps/hq/docs/DOCUMENTATION.md b/apps/hq/docs/DOCUMENTATION.md
index 20488db7f..14097d1c7 100644
--- a/apps/hq/docs/DOCUMENTATION.md
+++ b/apps/hq/docs/DOCUMENTATION.md
@@ -3473,7 +3473,7 @@ The system degrades gracefully-blocked sources are skipped while others continue
## Roadmap
-See [ROADMAP.md](ROADMAP.md) for detailed planning. Recent intelligence enhancements:
+See [ROADMAP.md](../ROADMAP.md) for detailed planning. Recent intelligence enhancements:
### Completed
@@ -3526,7 +3526,7 @@ See [ROADMAP.md](ROADMAP.md) for detailed planning. Recent intelligence enhancem
- **Additional Data Sources** - World Bank, IMF, OFAC sanctions, UNHCR refugee data, FAO food security
- **Think Tank Feeds** - RUSI, Chatham House, ECFR, CFR, Wilson Center, CNAS, Arms Control Association
-The full [ROADMAP.md](ROADMAP.md) documents implementation details, API endpoints, and 30+ free data sources for future integration.
+The full [ROADMAP.md](../ROADMAP.md) documents implementation details, API endpoints, and 30+ free data sources for future integration.
---