mzored/init-deep

README preview

# init-deep — AI Documentation Generator for Coding Assistants

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![CI](https://github.com/mzored/init-deep/actions/workflows/validate.yml/badge.svg)](https://github.com/mzored/init-deep/actions/workflows/validate.yml)
![No Dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)

init-deep is a codebase documentation tool that scans your project and generates platform-native context files so every AI coding assistant understands it. It runs as a slash command inside your AI assistant and writes the right documentation for each platform automatically — no manual maintenance required.

## Why init-deep

AI coding assistants work best when they have accurate, up-to-date context about your project — files like `CLAUDE.md`, `AGENTS.md`, and `.cursor/rules/`. Creating and keeping this AI assistant context synchronized across multiple platforms manually is tedious and error-prone. init-deep automates code documentation: it analyzes your project once and produces correctly formatted files for each platform from a single canonical source.

## Supported Platforms

- **Claude Code** — generates `CLAUDE.md` (project context) and scoped `.claude/rules/*.md` files
- **OpenAI Codex CLI** — generates `AGENTS.md` (the canonical source; read natively by Codex)
- **Cursor** — generates `.cursor/rules/*.mdc` (scoped module rules) and `.cursor/commands/init-deep.md`
- **Google Gemini CLI** — generates `GEMINI.md` (project context derived from `AGENTS.md`)
- **GitHub Copilot** — generates `.github/copilot-instructions.md` and `.github/prompts/init-deep.prompt.md`

View full repository on GitHub →