What is HQ?
What is HQ?
How long does it take to get started?
How long does it take to get started?
- ~2 min to create a Supabase project and an auth user
- ~5 min for Docker to pull images on first run (~1.5 GB)
- ~2 min to connect your model provider and create the first agent
Do I need to know how to code?
Do I need to know how to code?
curl | bash command. Everything else — Supabase setup, agent creation, routines — is done through the UI. You don’t need to edit any code or understand Docker internals to get started.If you want to customize agent templates, build your own, or contribute to the project, coding knowledge helps — but it’s entirely optional.Is there a hosted version?
Is there a hosted version?
Why self-host instead of using hosted?
Why self-host instead of using hosted?
- Your data stays on your machine. No third party has access to your CRM, knowledge, or agent outputs.
- Free. You only pay for your own infrastructure and model API costs.
- Open source. Fork it, customize it, ship your own version.
- Offline-capable. Gateways can run on a laptop or home server with no cloud dependency.
- Full template control. Modify agent templates directly on the filesystem.
Why the name "HQ"?
Why the name "HQ"?
Is this just a wrapper around OpenClaw / ChatGPT?
Is this just a wrapper around OpenClaw / ChatGPT?
How does this compare to CrewAI, OpenAI Agents SDK, or n8n?
How does this compare to CrewAI, OpenAI Agents SDK, or n8n?
- CrewAI / OpenAI Agents SDK are code frameworks — you write Python to orchestrate agents for a specific task. If you want to embed agents into an existing app, use those.
- n8n is a workflow builder — visual editor, hundreds of SaaS integrations, trigger-action patterns. If your problem is “when X happens, do Y in Z,” use n8n.
- HQ is a product — a self-hosted workspace your team logs into. Agents persist across days with memory, files, and identity. CRM, tasks, knowledge, and routines are built in.
Can I rip out the CRM / tasks / knowledge and just use the agents?
Can I rip out the CRM / tasks / knowledge and just use the agents?
What's the catch with the hosted version?
What's the catch with the hosted version?
DEPLOYMENT_MODE=hosted. No proprietary features, no lock-in.Agents & models
What is an agent?
What is an agent?
- A git branch — holds identity files, memory notes, skills, and docs
- A Chrome profile — persistent cookies and logged-in browser sessions
- A messaging channel — Telegram, Discord, Slack, or none
- An OpenClaw session — the runtime that executes prompts and tool calls
What models can agents use?
What models can agents use?
- API key providers: OpenAI, Anthropic, Google Gemini, DeepSeek, Mistral, Groq, OpenRouter, and 15+ more
- OAuth providers: OpenAI Codex, GitHub Copilot
- Local / self-hosted: Ollama, LM Studio, vLLM, any OpenAI-compatible server
Can I use a free / local model?
Can I use a free / local model?
http://host.docker.internal:11434.Local models are slower and less capable than frontier models for complex tasks, but they’re free and work offline.See the Ollama walkthrough in Connect a model provider →Can I use different models for different agents?
Can I use different models for different agents?
Can agents see each other and collaborate?
Can agents see each other and collaborate?
- @-mentions: type
@agent-slugin any task comment to wake that agent - Routines: set a routine so agent A’s output (a status change, new task, etc.) triggers agent B
- Org chart: agents can be arranged into a manager/direct-report hierarchy. That hierarchy is injected into agent boot context and gives agents a clear delegation model
What happens when an agent hits its budget limit?
What happens when an agent hits its budget limit?
- Soft threshold only — a notification fires when the agent crosses the warning percentage. The agent keeps working.
- Hard cutoff enabled — the runtime blocks further LLM replies and the dispatcher stops waking the agent for background work. The agent is effectively paused until the next budget period (first of the month) or until you raise the limit.
What agent templates are included?
What agent templates are included?
default, analytics, assistant, chief-of-staff, cmo, cofounder, crm-researcher, designer, ghostwriter, market-researcher, newsletter-editor, newsletter-writer, sales-copywriter, script-writer, social-strategist, social-writerEach template comes with pre-loaded identity files, skills, and a personality. You pick one when creating an agent — you can customize everything afterward.See Templates reference →Can I write my own agent template?
Can I write my own agent template?
templates/default/ to templates/your-role/, edit the identity files (IDENTITY.md, SOUL.md, USER.md, MEMORY.md), and add role-specific skills under skills/. The gateway picks up new templates automatically when it reboots.If your template might be useful to others, open a PR.See Agents →Self-hosting & operations
What hardware do I need?
What hardware do I need?
- Idle (1–2 agents): ~1.5 GB RAM, 5–10% CPU
- Active agent (browsing/running): +~500 MB RAM, CPU spikes during work
- t3.small (2 GB RAM): absolute floor, 1 agent
- t3.medium (4 GB RAM): comfortable for 2–3 active agents
- t3.large / m5.large: heavier use, 5+ agents
Does HQ need internet access?
Does HQ need internet access?
- Model API calls (unless using Ollama or another local model)
- Supabase connectivity (unless you self-host Supabase)
- OpenClaw plugin updates
Can I run multiple gateways?
Can I run multiple gateways?
GATEWAY_ID. Agents are bound to a specific gateway via a foreign key; the UI talks to each gateway via its stored reachable URL.Example: UI on your laptop, one gateway on a Mac mini at home, one gateway on a VPS — all pointing at the same Supabase database.To add a gateway: Settings → Gateways → Add Gateway. HQ generates a one-time registration token and gives you the installer command for the new host.See Add a gateway →Can I run multiple workspaces?
Can I run multiple workspaces?
COMPOSE_PROJECT in each .env — they get separate volumes and container names.Can I run HQ on a Raspberry Pi?
Can I run HQ on a Raspberry Pi?
How do I reach HQ from my phone?
How do I reach HQ from my phone?
- Tailscale (recommended) — install Tailscale on both your phone and the HQ host, access via
http://<host-tailscale-ip>:3000. Private, no port exposure. - Tailscale Serve —
sudo tailscale serve --bg --https=443 localhost:3000→ TLS access athttps://hq.<tailnet>.ts.net - Tailscale Funnel — makes HQ accessible from the internet without Tailscale on the phone
- Reverse proxy — Cloudflare Tunnel, nginx, Caddy, etc. (see Networking)
How do I update HQ?
How do I update HQ?
How do I back up my data?
How do I back up my data?
- Supabase — your contacts, tasks, agents, knowledge items, audit log. Use Supabase built-in backups (Pro tier) or
pg_dumpto a file. See Operations → - Gateway state volume — per-agent git branches, Chrome profiles, OpenClaw config. Back up with
docker run --rm -v yourhq-gateway-state:/src -v $(pwd):/dst alpine tar -czf /dst/gateway-state.tar.gz -C /src . .env— contains secrets. Store in a password manager or encrypted disk.
GIT_REMOTE_URL in .env to continuously sync agent branches to GitHub/Gitea.How do I uninstall?
How do I uninstall?
What does it cost to run?
What does it cost to run?
- Laptop / home server: free
- Hetzner CX22 (~2 vCPU, 4 GB RAM): ~$4/month
- AWS t3.medium (2 vCPU, 4 GB RAM): ~$20/month
Data & security
Who can see my data?
Who can see my data?
How is multi-tenancy handled?
How is multi-tenancy handled?
tenant_id, and RLS policies restrict access to rows matching the authenticated user’s tenant. Self-hosted installs use a single default tenant. On top of that, the multi-workspace registry gives each workspace its own Supabase project for full database-level isolation. The UI’s workspace switcher lets one HQ instance manage multiple isolated workspaces.See Security model →How do I report a security issue?
How do I report a security issue?
[email protected]. Do not open a public GitHub issue for security vulnerabilities.See Security policy →Is my service role key safe?
Is my service role key safe?
ui-config Docker volume on your host — never sent to or stored by Anthropic or the HQ maintainers. It’s included in .env for the gateway daemons that need direct database access.Treat it like a database password: don’t commit it to public repos, don’t share it in screenshots. If it leaks, regenerate it in Supabase → Settings → API.Customization & development
Can I customize the UI?
Can I customize the UI?
apps/ui/ is a standard Next.js app (App Router, Tailwind CSS, shadcn components). Modify, rebuild, and deploy from your fork. Pull upstream changes at your own cadence.If your changes might benefit others, open a PR.Can I add my own agent templates?
Can I add my own agent templates?
templates/default/ to templates/your-role/ and edit the identity files. The gateway picks up new templates from /opt/templates/ at boot. Rebuild the gateway image with your templates included, or set TEMPLATES_SOURCE in .env to point at an external repo.See Templates reference →Can I add custom routines or triggers?
Can I add custom routines or triggers?
- A new entry in the routine trigger type enum (via a migration)
- A place in the UI or a backend hook that creates the
agent_inbox_itemsrow - The dispatcher handles it automatically — it dispatches any actionable inbox item
How do I contribute?
How do I contribute?
- Read Contributing → for the PR process
- Bug reports: GitHub Issues
- Design questions, roadmap: GitHub Discussions
- Security issues:
[email protected]only
Who uses HQ?
Who uses HQ?

