HEADING OS — Quickstart
The one-page version. For the full zero-to-running walk-through, see DEPLOYMENT.md.
Install (short form)
Once you have WSL2/Ubuntu (Windows) or a Unix shell, plus git, gh, uv, Node, and
the Claude CLI:
mkdir -p ~/ai/claude-workspaces && cd ~/ai/claude-workspaces
# 1. Clone the engine
git clone https://github.com/<org>/heading-os.git .heading-os
cd .heading-os
# 2. Install dependencies (Python managed by uv) + arm the secret gate
uv sync
pre-commit install
# 3. Create your own private data repository (one command)
uv run python scripts/create-data-repo.py
# 4. Wire secrets
cp .env.example .env # fill in what you use
# 5. Verify, then start
uv run python scripts/workspace-health.py
claude # then /prime
Full prerequisites, platform setup, authentication, plugins, and troubleshooting are in DEPLOYMENT.md.
First session
| Step | Command |
|---|---|
| Start a session | claude (trust the engine folder) |
| Load context | /prime |
| See what to do next | /next |
| Back up your data | /backup |
A clean /prime means everything works. A fresh data overlay looks sparse — that is
expected until you create or import records.
Everyday essentials
| Command | Does |
|---|---|
/prime |
Load context, surface alerts, reorient |
/dashboard |
Morning brief — inbox, calendar, pipeline in one view |
/osint <target> |
Deep research on a company, person, or market |
/meeting-prep <name> |
Dossier + talking points for a meeting |
/email-intel |
Triage your inbox (drafts only; never auto-sends) |
/crm |
Add, log, find contacts; check who’s overdue |
/backup |
Commit & push your data overlay |
/sync |
Pull engine updates + refresh shared content |
You can also just describe what you want in plain language — “research this company”, “draft a reply”, “who haven’t I followed up with” — and it routes to the right capability automatically.
Outbound is always human-gated. Email and messages are drafted and shown to you first. Nothing sends on its own.
HEADING OS · Quickstart · see DEPLOYMENT.md for the full guide and
the in-workspace /prime for live orientation.