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.

Templates are role-specific starting points for agents. They live in templates/ and get seeded into the gateway’s local git repo as template/<name> branches on first boot.

Template files

FilePurpose
agent.jsonRuntime metadata: slug, name, description, team, capabilities, browser color
IDENTITY.mdRole, voice, and domain behavior
SOUL.mdGoals and non-negotiables
USER.mdOwner profile placeholders (filled at provision time)
MEMORY.mdStarting long-term context
TOOLS.mdTool-use guidance
AGENTS.mdAgent-specific instructions
skills/Reusable procedures and scripts

How provisioning works

When you create an agent, HQ forks the selected template branch into the agent’s personal branch, then patches identity fields (slug, name, emoji, channel). The model field is optional — agents use the default provider configured in Settings → Connections unless overridden per-agent from the agent detail page.
To create a custom template, copy templates/default/ to templates/your-role/, edit the identity files, add role-specific skills, and rebuild the templates index. See Agents → Writing a new template for the full walkthrough.