> ## 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.

# Quickstart

> Get HQ v0.2.2 running in about 10 minutes. You need Docker, a free Supabase account, and a model API key.

<Info>
  **Not technical?** That's fine. The install is one command in a terminal and a few steps in your browser. You don't need to edit code or understand Docker to get started. Or skip infrastructure entirely with [HQ hosted](/hosted/getting-started).
</Info>

## Before you begin

You need three things. All are free to start.

<CardGroup cols={3}>
  <Card title="Docker" icon="docker">
    Runs everything locally. [Download Docker Desktop](https://docs.docker.com/desktop/) for Mac or Windows. On Linux, the installer handles it.
  </Card>

  <Card title="Supabase account" icon="database">
    Free at [supabase.com](https://supabase.com). This is where your workspace data lives — on your own account.
  </Card>

  <Card title="Model API key" icon="plug">
    Any provider works. OpenAI and Anthropic are the most common. You'll add this during the onboarding wizard.
  </Card>
</CardGroup>

<Tip>
  Want to access HQ from your phone or another laptop? Sign up for [Tailscale](https://tailscale.com) (free) before installing and the installer will configure it for you.
</Tip>

***

## Step 1 — Create a Supabase project

<Steps>
  <Step title="Create a project">
    Go to [supabase.com](https://supabase.com), sign in, and create a new project. Choose any name and region. Wait about 2 minutes for it to provision.
  </Step>

  <Step title="Create an auth user">
    Go to **Authentication → Users** in your Supabase dashboard. Click **Add user → Create new user**. Enter an email and password — this is what you'll use to log in to HQ. Check "Auto Confirm User" so you can sign in immediately.
  </Step>

  <Step title="Disable public signup">
    Go to **Authentication → Providers → Email** and turn off "Enable email signup". This prevents strangers from creating accounts in your workspace — only the user you just created can log in.
  </Step>

  <Step title="Copy your API keys">
    Go to **Project Settings → API** (gear icon in the left sidebar). You'll need three values — keep this tab open:

    | Key                  | Where to find it                                | What it's for                                                |
    | -------------------- | ----------------------------------------------- | ------------------------------------------------------------ |
    | **Project URL**      | Top of the API page                             | How HQ finds your Supabase project                           |
    | **Anon public key**  | Under "Project API keys"                        | Public identifier (safe to share)                            |
    | **Service role key** | Under "Project API keys" (secret — don't share) | Master key with full database access — treat like a password |

    <Warning>
      The service role key bypasses all security policies and has full access to your database. Treat it like a password.
    </Warning>
  </Step>
</Steps>

***

## Step 2 — Install HQ

Open a terminal on your Mac or Linux machine (on Windows, use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) — Windows Subsystem for Linux) and run:

```bash theme={null}
curl -fsSL install.yourhq.ai | bash
```

The installer will ask you a couple of questions:

1. **GitHub sync** — optional backup for agent files. Skip for now (press Enter) — you can enable it later in Settings.

It pulls Docker images (\~1.5 GB on first run — this takes a few minutes), starts the stack, and opens your browser.

<Tip>
  Prefer to inspect the code first? Clone the repo and run it manually:

  ```bash theme={null}
  git clone https://github.com/yourhq/yourhq.git
  cd yourhq
  cp .env.example .env
  docker compose up -d ui
  ```
</Tip>

***

## Step 3 — Complete the onboarding wizard

Your browser opens to `http://localhost:3000`. Sign in with the email and password you created in Step 1, then the **onboarding wizard** walks you through everything in one flow:

<Steps>
  <Step title="Welcome">
    Enter your name and confirm your workspace name (auto-generated, editable).
  </Step>

  <Step title="Intent">
    Pick what you'll use HQ for — outreach, deals, hiring, publishing, ops, or exploring. This seeds a recommended agent template and workspace context.
  </Step>

  <Step title="Infrastructure">
    Paste the three Supabase values you copied in Step 1 (Project URL, anon key, service role key). Then choose where to run your gateway — "This machine" (Docker, already running) or "Remote server" (copy a one-liner to another host).

    HQ validates the database connection, installs the schema automatically if needed, and waits for the gateway to come online.
  </Step>

  <Step title="Model provider">
    Choose **Anthropic**, **OpenAI**, or **Ollama** and enter your API key. HQ validates it inline. For Ollama, it auto-detects the local instance — just make sure Ollama is running.
  </Step>

  <Step title="First agent">
    HQ recommends an agent based on your intent. Customize the name and emoji if you'd like, then create it. Optionally connect a messaging channel (Telegram, Discord, Slack) to talk to your agent via DM.
  </Step>
</Steps>

After creation, you land on the **Tasks** page with a suggested first task pre-filled.

<Info>
  If you see a "table does not exist" error during the infrastructure step, the one-click schema install may not have completed. Re-run it from the onboarding wizard, or manually apply the migration files from [`db/migrations/`](https://github.com/yourhq/yourhq/tree/main/db/migrations) in the Supabase SQL Editor. See [Supabase setup](/self-host/supabase) for details.
</Info>

***

## You're set up

Your HQ (v0.2.2) is running with a connected database, model provider, and first agent. The gateway runs OpenClaw 6.6 and includes automatic backup/restore — your agent state is backed up to Supabase Storage on shutdown and restored on fresh boot.

<Warning>
  **Putting this on the internet?** The default install binds services to `127.0.0.1` — safe on a laptop. The runner mounts the Docker socket (so it can restart the stack from the UI), and your Supabase service-role key sits in `.env` with full database access. Read the [security policy and hardening guide](/security/security-policy) before exposing HQ beyond localhost.
</Warning>

Here's what to explore next:

<CardGroup cols={2}>
  <Card title="Pick a model per agent" icon="sliders" href="/guides/connect-model-provider#per-agent-model-overrides">
    Assign different models and thinking levels to each agent. Mix cheap and expensive models across your fleet.
  </Card>

  <Card title="Understand agents" icon="robot" href="/concepts/agents">
    Memory, files, skills, org chart, and how agents actually work.
  </Card>

  <Card title="Set usage budgets" icon="gauge-high" href="/guides/usage-budgets">
    Avoid surprise API bills with per-agent monthly limits.
  </Card>

  <Card title="Access from other devices" icon="network-wired" href="/self-host/networking">
    Set up Tailscale so your phone and laptop can reach HQ.
  </Card>

  <Card title="Add knowledge" icon="book" href="/concepts/knowledge">
    Upload files, write pages, or sync sources. Scope items to workspace, agent, or library.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/troubleshooting/common-issues">
    Something didn't work? Common fixes are here.
  </Card>
</CardGroup>