Skip to main content

automadocs / index.md

Living docs for your private repo that your coding agent can read.

AutomaDocs reads your GitHub code, writes docs that re-sync on every push, and answers questions with the exact source lines. Cursor and Claude Code read the same docs over MCP.

See it on real code

Paste any public GitHub repo

No signup. You watch the docs get written, then ask the repo a question.

Examples, click to fill

Free for 1 repository, no credit card. Pro $49/month, Team $149/month. Compare plans

Why not DeepWiki?

It is a good free way to browse public repos. This is where we differ.

  • Private repos, your GitHub login

    DeepWiki is free on public repos. For private code it asks for a Devin account. AutomaDocs connects with the GitHub account you already use.

  • Docs that follow your pushes

    Docs re-sync when you push, and answers cite the exact source lines so you can check them before you rely on them.

  • Readable by your tools

    An MCP server lets Cursor and Claude Code read the docs. A CLI and GitHub Action can gate doc coverage in CI.

Read the full comparison

01

Workflow

From the first read
to the next push.

A shared reference for the questions your team keeps asking. Connect the source, review the docs, and keep them current.

  1. 01

    Connect your repository

    Sign in with GitHub and choose the repository you want to document, private or public.
  2. 02

    Read and verify

    Explore generated explanations, inspect source citations, and use health scores to find gaps.
  3. 03

    Keep the context current

    Push code changes to trigger documentation updates. Ask repo questions with source references.

02

Citations

How citations work.
The source makes the answer verifiable.

Repo chat connects its answers to source files and line numbers. Open the reference to check the details before acting.

Explore the features
cart.jsPrepared example, not a live result

Source, the reference

  1. function calculateSubtotal(items) {
  2. return items.reduce((total, item) => {
  3. return total + item.price * item.quantity;
  4. }, 0);
  5. }

Repo chat

What happens when the cart is empty?

The reduction starts at zero, so an empty list returns 0.

Cited lines

items
Array of items with price and quantity
Returns
The numeric subtotal
Choose a citation to see the lines it points at. Open the product tour or the snippet demo to run your own code.

03

Surfaces

Your docs inside every AI editor and terminal

Engineers shouldn't have to switch contexts to find answers. AutomaDocs exposes an MCP server, CLI, and GitHub Action so your docs live where you write code.

terminal: automadocs-cli (zsh)
MCP Synced
Fast terminal answers directly from local codebase AST
$automadocs ask "Where is webhook signature verification handled?" --repo automadocs
AutomaDocs RAG Engine (BM25 + AST Vector)Example output

Webhook signatures are verified in backend/src/routes/billing.js. The raw request body is preserved by the Next.js API route proxy before checking the stripe-signature header against your webhook secret.

backend/src/routes/billing.js:42-88
app/api/stripe/webhook/route.ts:18-35
Tip: Claude Code and Cursor can read this automatically via packages/mcp-server with zero configuration.
Works out-of-the-box with our free developer surfaces in packages/Explore MCP & CLI docs

04

Evaluate

Know what you are connecting.

  1. 01

    Plans and limits

    Compare included repos, generations, and team features.
  2. 02

    Code and access

    Read how repository access and your data are handled.
  3. 03

    Other approaches

    Compare documentation tools for your team's needs.

05

FAQ

Common questions

What teams ask before connecting their first repo.

More questions? View the full FAQ →

Start with your source

Give your team a place to find answers.

Connect a repository and generate your first docs.

Connect GitHub