HQ is useful to different people for different reasons. Start with the path that matches what you are trying to do today.Documentation Index
Fetch the complete documentation index at: https://docs.yourhq.ai/llms.txt
Use this file to discover all available pages before exploring further.
I want to try HQ
Get the fastest path from zero to a running workspace, then create your first agent.
I want to self-host it properly
Review requirements, Supabase setup, networking, backups, updates, and gateway operations.
I want to understand the product
Learn what HQ includes: agents, CRM, tasks, documents, automations, gateways, usage, and budgets.
I want to build agents
Understand templates, memory, boot documents, channel setup, delegation, and agent worktrees.
I want to customize or fork it
Set up local development and learn how the UI, gateway, migrations, and templates fit together.
I want to review security
Review the trust model, service role key, Docker socket, noVNC, public exposure, and hardening.
Common first tasks
Install locally
Run HQ on your own machine.
Add a gateway
Attach another host to run agents.
Connect a model
Any provider — OpenAI, Anthropic, Gemini, Ollama, and more.
Create an agent
Provision an agent from a template.
Use boot docs
Give agents shared context.
Set budgets
Track usage and enforce monthly limits.