Overview
Agents
These docs are queryable from the command line. The same engine behind the
⌘K search on this site ships as a CLI, so your coding agent can search,
read, and cite the Layer docs directly — no scraping, no MCP server, no API
key. Two commands wire it up.
1. Install the CLI
go install github.com/hev/ask/cmd/ask@latest
The binary is self-contained; any agent harness that can run a shell command can use it.
2. Add the skill
For Claude Code, paste this once:
mkdir -p ~/.claude/skills/hevlayer-docs
cat > ~/.claude/skills/hevlayer-docs/SKILL.md <<'EOF'
---
name: hevlayer-docs
description: >-
Query the hev layer docs. Use when the user asks about Layer — the
Turbopuffer gateway, strong-consistent reads, the stable watermark,
the pull-through document cache, warm jobs, scans, result count,
snapshots, pipelines, UDFs, the Index/InfraRules/Pipeline/Function
CRDs, compute pools, install via Terraform or Helm, failure modes,
or the dashboard.
---
# hev layer docs
Answer Layer questions from the docs, not from memory. Every verb is a
keyless read:
ask --endpoint https://hevlayer.com/api/ask search "<question>"
ask --endpoint https://hevlayer.com/api/ask section get "<id>"
ask --endpoint https://hevlayer.com/api/ask overview
ask --endpoint https://hevlayer.com/api/ask glossary get "<term>"
Start with `search`; fetch sections for detail; use `overview` when you
need the full map. Section ids look like
`api/query#strong-consistent-reads`. Cite sections in your answer as
https://hevlayer.com plus the returned `url` field.
If `ask` is missing, install it:
`go install github.com/hev/ask/cmd/ask@latest`
EOF
Other harnesses: paste the body of that skill into your AGENTS.md — it is
plain instructions around a CLI, nothing Claude-specific.
3. Ask
ask --endpoint https://hevlayer.com/api/ask search "cache is down"
{
"results": [
{
"title": "Concepts",
"heading": "Pull-through cache",
"url": "/docs/concepts#pull-through-cache",
"group": "Overview",
"snippet": "Document reads are served by a pull-through cache: the gateway checks..."
}
]
}
From here your agent typically runs section get on the winning id and
answers with the citation.
The verbs
| Verb | Returns |
|---|---|
overview | Orientation context plus the full section map with stable ids |
search "<query>" | Ranked sections with snippets and deep links |
section get "<id>" | One section: summary, exact identifiers, source URL |
glossary get "<term>" | A product term resolved through its aliases (watermark → stable watermark) |
Why answers stay grounded
Search runs over a committed, reviewable digest of these docs — the same corpus, heading by heading, that renders on this site. Every anchor in it is verified against the rendered pages in CI, so a cited deep link like /docs/api/query#strong-consistent-reads always resolves. When the docs change, the digest is rebuilt and recommitted with them.
The docs are also available as plain text for direct ingestion: /llms.txt (index) and /llms-full.txt (full corpus). The CLI is the better path for agents that can run commands — it ranks, resolves aliases, and costs a fraction of the tokens.