FlatRepo

A CLI tool for generating a full repository documentation into a single markdown file.

Very useful to load knowledge to your favorite AI Agent like Claude AI Projects or ChatGPT Context.

Installation

npm install -D flatrepo

Optional: You can set as script in your package.json

{
  "scripts": {
    "flatrepo": "flatrepo"
  }
}

Usage

• Generate documentation in to default filename (flatrepo_YYYYMMDDHHIISS.md):

flatrepo

• Generate documentation in to a custom filename:

flatrepo myrepo.md

• Generate documentation including a description of binary files:

flatrepo myrepo.md --include-bin

Features

• Generates markdown documentation of your repository
• Includes YAML header with repository statistics
• Ignore binary files (images, videos, zip, etc...)
  • Include with description
• Respects .gitignore patterns
• Supports multiple file types
• Formats code blocks according to file type