Where to Find AG Kit Documentation: The Complete Guide for vudovn/ag-kit

All official AG Kit documentation is maintained inside the repository itself, with the root README.md serving as the primary entry point linking to specialized guides covering CLI usage, migration paths, and security policies.

AG Kit is an open-source toolkit developed in the vudovn/ag-kit repository. Rather than hosting documentation on an external site, the project adopts a docs-as-code approach, keeping all markdown files versioned alongside the source. This ensures that ag-kit documentation always matches the code you have checked out, eliminating version drift between guides and implementation.

Primary Documentation Entry Points

The repository organizes its knowledge base into logical sections, each residing in dedicated markdown files at predictable paths.

Root README.md

The central hub for all AG Kit documentation is README.md in the repository root. This file contains the Quick start and Documentation sections that link to every other guide. According to the vudovn/ag-kit source code, this is the first file you should open when onboarding or seeking reference material.

CLI Usage Documentation

For command-line interface specifics, consult cli/README.md. This document details the @vudovn/ag-kit package commands, including initialization workflows and global installation options.

Migration and Upgrade Guides

When upgrading between versions, reference MIGRATION.md. This file provides step-by-step guidance for transitioning from earlier releases, including breaking changes and recommended update paths.

Security and Production Policies

Critical for production deployments, SECURITY.md contains the project's threat model and safe-hook descriptions, while PRODUCTION_CHECKLIST.md offers a validation checklist before shipping releases. These files ensure you understand AG Kit's security posture and deployment requirements.

Architecture and Deep Dive References

For contributors or advanced users needing implementation details, the repository includes architecture documentation within the .agents/ directory.

Toolkit Architecture

.agents/ARCHITECTURE.md describes the internal structure of the toolkit workspace, explaining how components interact and where to find specific modules. This is essential reading for anyone extending the framework or debugging complex interactions.

Hooks and Antigravity Details

The .agents/hooks/README.md file documents the native safety hook implementation and MCP (Model Context Protocol) synchronization scripts. For Antigravity-specific operations, this file explains the hook lifecycle and verification procedures.

Building the Web Documentation Site

While all ag-kit documentation source lives in markdown files, the repository includes a Next.js application that renders these files as a styled website. After installing the CLI, you can generate and browse the documentation locally:

# Build the web documentation

npm run build:web

Open the generated output to navigate the same markdown content through a searchable, formatted interface.

Essential CLI Commands for Documentation Verification

The AG Kit CLI includes several verification commands that validate your local setup against the documentation specifications.

Installation

Initialize AG Kit in your project using npx or install the CLI globally:

# Recommended: Initialize without global install

npx @vudovn/ag-kit init

# Alternative: Install globally first

npm install -g @vudovn/ag-kit
ag-kit init

Workspace Health Checks

Verify that your workspace matches documented requirements:

# Validate the .agents/ workspace structure

npm run check:agents

# Run the Antigravity "doctor" diagnostic

npm run check:antigravity

# Execute the full hook test suite

npm run test:antigravity

Safe Updates

Before upgrading AG Kit versions, preview changes against the current documentation:

# Preview changes without applying them

ag-kit update --dry-run

Plugin Development

When working with the Antigravity plugin as documented in the architecture guides:

# Build the plugin bundle

npm run build:antigravity-plugin

# Output appears under dist/antigravity-plugin/

Summary

• All ag-kit documentation resides in the vudovn/ag-kit repository, with no external documentation site required.
• Start at README.md for the overview and navigation hub.
• Reference cli/README.md, MIGRATION.md, PRODUCTION_CHECKLIST.md, and SECURITY.md for specialized topics.
• Check .agents/ARCHITECTURE.md and .agents/hooks/README.md for deep technical implementation details.
• Generate a local web site with npm run build:web if you prefer browsing documentation in a styled interface.
• Use ag-kit update --dry-run to preview upgrades before they affect your workspace.

Frequently Asked Questions

Where is the official AG Kit documentation hosted?

All official documentation exists as markdown files within the vudovn/ag-kit GitHub repository. There is no separate documentation website; instead, the project maintains a docs-as-code approach where README.md serves as the central hub linking to guides like MIGRATION.md, SECURITY.md, and .agents/ARCHITECTURE.md.

How do I access the AG Kit documentation if I want a web interface?

While the source files are markdown, the repository includes a Next.js application for generating a styled documentation site. Run npm run build:web after installing the CLI to compile the markdown files into a browsable website, or read the raw .md files directly on GitHub through the repository file browser.

What is the difference between README.md and cli/README.md in AG Kit?

The root README.md provides the high-level project overview, quick-start instructions, and links to all other documentation sections. The cli/README.md file specifically documents the command-line interface, detailing how to install the @vudovn/ag-kit package globally, initialize projects, and use specific CLI commands like ag-kit init and ag-kit update.

Which file should I read before deploying AG Kit to production?

Before shipping to production, review PRODUCTION_CHECKLIST.md for deployment validation steps and SECURITY.md for understanding the project's security model and threat mitigations. Additionally, verify your local setup matches documented requirements by running npm run check:agents and npm run check:antigravity as specified in the .agents/ARCHITECTURE.md and hooks documentation.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}