Doc Bridge
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-bridge

CLI binary: ak-docs.

Prove it in 60 seconds (no project setup)

npx ak-docs demo --text
npx ak-docs demo --fixture monorepo --text

You 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 run

Expected handoff fields:

FieldMeaning
startHereWhat the agent reads first
editRootsWhere edits are allowed
checksCommands that prove the change
humanDocHuman 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):

  1. routing.options.ownership in config
  2. Frontmatter on agent docs (package, editRoot, checks)
  3. Monorepo plugin discovery (pnpm-monorepo)

Dev loop

ak-docs index --watch
ak-docs list packages --text
ak-docs ask "where do I change auth?"

The AgentsKit ecosystem

Build the agent. Then take it all the way.