Guides
Install Doc Bridge, run the demo, and index your repository in minutes.
View raw Markdown · llms.txt · For agents
Install and run
Get a deterministic AgentHandoff from your own docs — no API key required for Layer 0.
Install
pnpm add -D @agentskit/doc-bridge
# or
npm i -D @agentskit/doc-bridgeCLI binary: ak-docs.
Prove it in 60 seconds (no project setup)
npx ak-docs demo --text
npx ak-docs demo --fixture monorepo --textYou should see handoffs, a gate red→green path, and an MCP install snippet.
Two-minute path on your repo
cd your-repo
ak-docs init # config + optional demo ownership + AGENTS.md tip
ak-docs index # build .doc-bridge/index.json
ak-docs query package example --agent
ak-docs doctor --text
ak-docs gate runExpected handoff fields:
| Field | Meaning |
|---|---|
startHere | What the agent reads first |
editRoots | Where edits are allowed |
checks | Commands that prove the change |
humanDoc | Human guide for the same ownership |
Minimal config
doc-bridge.config.json:
{
"schemaVersion": 1,
"corpus": {
"agent": { "root": "docs/for-agents" }
}
}Required: schemaVersion: 1 and corpus.agent.root.
Ownership comes from (first match wins):
routing.options.ownershipin config- Frontmatter on agent docs (
package,editRoot,checks) - Monorepo plugin discovery (
pnpm-monorepo)
Dev loop
ak-docs index --watch
ak-docs list packages --text
ak-docs ask "where do I change auth?"Related
- Index and query — resolve ownership deterministically
- Gate and CI — fail stale context in PRs
- MCP for agents — wire Cursor / Claude / Codex
- Config reference
- Examples
The AgentsKit ecosystem