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.

This quickstart gets Your HQ running on a Docker host with your own Supabase project.
If you are not technical, the important idea is simple: HQ runs on your computer or server, and Supabase stores your workspace data.

​
What you need

Docker

Runs the HQ UI and gateway containers.

Supabase

Stores your workspace, auth, tasks, agents, and command queues.

Model provider

Any provider — OpenAI, Anthropic, Gemini, Ollama, or 25+ others. HQ is model-agnostic.

Optional: Tailscale

Private remote access from your phone, laptop, or another machine.

​
Quickstart steps

1

Create a Supabase project

Create a free project at supabase.com, then run every SQL file in db/migrations/ in filename order.
2

Start HQ

On a Linux or macOS host with Docker:
curl -fsSL install.yourhq.ai | bash
If you prefer to inspect the code first:
git clone https://github.com/yourhq/yourhq.git
cd yourhq
cp .env.example .env
docker compose up -d
3

Complete onboarding

Open http://localhost:3000.Paste your Supabase project URL, anon key, and service role key. Then sign in or create a Supabase auth user.
4

Set up the workspace

Choose workspace details, owner profile, pipeline stages, fields, and task streams. You can change these later.
5

Connect a model provider

Go to Settings → Connections. API-key providers can be added directly; interactive providers show the next step in the UI.
6

Create your first agent

Go to Agents → New Agent. Pick a template, name the agent, choose a messaging channel (Telegram, Discord, Slack, or None), enter the channel credentials, and complete any pairing step.

Full installation guide

More setup paths, updates, and install troubleshooting.

Understand agents

How templates, memory, channels, boot docs, and delegation work.

Add another gateway

Run agents on a second machine.

Troubleshooting

Fix common setup, Supabase, gateway, and agent issues.