Skip to main content

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.

HQ is an open-source workspace for running AI agents on infrastructure you control. It combines agents, CRM, tasks, documents, automations, provider connections, gateways, and usage budgets in one self-hosted dashboard. You can use Your HQ as a non-technical operator, a technical self-hoster, an agent builder, or a developer who wants to fork and extend the project.

Start from zero

Install Your HQ, connect Supabase, finish onboarding, connect a model provider, and create your first agent.

Pick the right path

Not sure where to begin? Choose a path for self-hosting, using Your HQ, building agents, contributing, or security review.

​
What you can do with Your HQ

Run agents

Create long-lived agents with their own memory, tools, browser profile, messaging channel, and worktree.

Manage work

Use CRM, tasks, documents, assets, automations, notifications, and activity in one workspace.

Self-host anywhere

Run the UI and gateways on a laptop, home server, Raspberry Pi, VPS, or multiple hosts.

Connect models

Any model, any provider. OpenAI, Anthropic, Gemini, Ollama, and 25+ more.

Control spend

Track model usage per agent and enforce monthly usage budgets with hard cutoffs.

Fork and extend

Customize templates, skills, UI modules, gateway commands, migrations, and integrations.

​
How HQ fits together

HQ UI  →  your Supabase project  →  gateway hosts  →  agents
The UI is where you manage work. Supabase is the shared state layer you own. Gateways are Docker hosts that run agents. Agents are persistent workspaces that can browse, read context, update files, and process assigned work.

Read the architecture

Understand the runtime, queues, daemons, files API, and data flows.

Review the security model

Understand the real trust boundaries before exposing HQ beyond localhost.

​
Open source by design

HQ is not a hosted-first product with a self-hosted checkbox. The repo is the product. The docs include UI paths, manual paths, operational notes, security risks, and extension points so you can run it yourself or build your own version.