Get started

Point your agent at WarmHub.

Give your agent shared, versioned knowledge it can read from and write back to. Pick the path that fits your stack — the CLI or MCP — or hand the whole setup to your agent.

Fastest

Hand it to your agent

Copy this onboarding prompt, paste it into Claude Code, Cursor, or Codex, and your agent walks you through connecting — one step at a time.

Download .md

Choose your path

Connect via the CLI or MCP

Pick the surface your agent already speaks. You can always wire up the other later — they talk to the same WarmHub.

Drive WarmHub from your terminal

Install the wh CLI, sign in once, then run wh prime so your agent knows every command available to it — and can shell out to them directly.

Running headless or in CI? Create a token with wh token create --name my-agent and set WH_TOKEN.

your-machine
# 1 · install the WarmHub CLI (requires Node 22+)
$ npm install -g @warmhub/cli
# 2 · sign in — opens your browser
$ wh auth login
✓ signed in — token saved to ~/.warmhub/auth.json
# 3 · load WarmHub's command reference into your agent
$ wh prime
~/your-project
# discover what an org has published
$ wh repo list warmhub-data
# pull data straight into your agent's context
$ wh thing list --shape StockTrade --limit 10 \
--repo warmhub-data/congress-trading
Full CLI reference →

Going further

Prefer code? Use the SDK.

Call WarmHub directly from TypeScript when you want full control — or dive into the docs for everything else.

TypeScript SDK

Install the client, hand it a token getter, and call WarmHub from your own code.

client.ts
$ npm install @warmhub/sdk-ts
import { WarmHubClient } from '@warmhub/sdk-ts'
const client = new WarmHubClient({
auth: { getToken: async () => process.env.WH_TOKEN },
})
Full SDK setup →

Everything else is in the docs.

Full command reference, MCP tool walkthroughs, SDK guides, and auth — all at docs.warmhub.ai.

Full quickstart docs