lr-ai-docs

AI-powered project documentation generator using coding agent CLIs (Claude Code, GitHub Copilot, Gemini CLI). Analyzes your .NET project and produces a full set of developer documentation — from quickstart guides to architecture overviews to framework-specific developer guides.

Commands

The tool provides four independent commands. Each can be run separately or combined for a full documentation pass.

apply-agents

Creates or updates AI agent instruction files so coding assistants understand your project:

• AGENTS.md — Project-level instructions
• .claude/CLAUDE.md — Claude Code instructions
• .github/copilot-instructions.md — GitHub Copilot instructions
• .junie/guidelines.md — JetBrains Junie guidelines

Uses an information-preservation approach: existing customizations are kept, and template content is merged in. The result is also added to the .sln solution file.

lr-ai-docs apply-agents
lr-ai-docs apply-agents --working-dir /path/to/project

apply-dotfiles

Creates or updates project dotfiles with a baseline for .NET projects:

• .gitignore — Git ignore patterns for .NET builds, IDEs, temp files
• .gitattributes — Line ending and diff behavior for file types
• .editorconfig — Code style, indentation, and formatting rules
• .aiignore — AI tool ignore patterns
• .dockerignore — Docker build context exclusions
• .stignore — Syncthing ignore patterns

Uses the same information-preservation approach: existing entries are kept, missing entries from the template are added.

lr-ai-docs apply-dotfiles
lr-ai-docs apply-dotfiles --working-dir /path/to/project

apply-library-devguides

Discovery-based developer guide generation. Scans the project for *.prompt.md sentinel files shipped by framework NuGet source-distribution packages, then for each:

1. Parses YAML frontmatter (target and description) and relevance criteria from the body
2. Finds the paired .md template in the same directory
3. Asks the coding agent to check if the guide is relevant to this project
4. If relevant, the agent adapts the template with project-specific details and writes it to docs/
5. If not relevant, the guide is skipped

This replaces the old hardcoded set_name approach — devguides are now driven entirely by what framework packages are installed. Results are added to the .sln solution file.

lr-ai-docs apply-library-devguides
lr-ai-docs apply-library-devguides --working-dir /path/to/project

Sentinel file format (*.prompt.md):

---
target: "40_DevGuide_DatabaseModels.md"
description: "Desired-state database migration system"
---

Check if this project uses it:
- Look for a Migrations/ directory containing C# files
- Check if any class inherits from SchemaDeclaration

apply-standard-docs

Generates standard documentation by prompting the coding agent to deeply inspect the project:

• docs/10_Quickstart.md — Prerequisites, setup, environment configuration, running the app
• docs/20_Deployment.md — Environments, CI/CD, infrastructure, rollback procedures
• docs/80_Architecture.md — Technology stack, project structure, data architecture, integrations
• README.md — Project overview with links to detailed docs

All generated docs are added to the .sln solution file.

lr-ai-docs apply-standard-docs
lr-ai-docs apply-standard-docs --working-dir /path/to/project

Full documentation pass

To generate everything for a project:

lr-ai-docs apply-agents --working-dir /path/to/project
lr-ai-docs apply-dotfiles --working-dir /path/to/project
lr-ai-docs apply-library-devguides --working-dir /path/to/project
lr-ai-docs apply-standard-docs --working-dir /path/to/project

Options

All commands accept:

Prerequisites

• .NET 10 SDK
• At least one coding agent CLI installed and available in PATH:
  • Claude Code (preferred) — requires ANTHROPIC_DEFAULT_OPUS_MODEL environment variable (e.g., claude-opus-4-6)
  • GitHub Copilot CLI
  • Gemini CLI

Installation

dotnet tool install -g lr-ai-docs

Or run directly without installing:

dotnet tool run lr-ai-docs apply-agents

Building from source

git clone <repository-url>
cd lr_ai_docs
dotnet build AiDocs

To pack and publish the NuGet package:

./pack-cli.sh

This sets the package version from the current timestamp (YYYY.MM.DD.HHMM) and pushes to the configured NuGet feeds.