Generate comprehensive project documentation for AI assistants - Share your entire codebase context in one markdown file
npm install proggabash
npx progga@latest
`
This generates a file named:
`
PROJECT_DOCUMENTATION.md
`
in the current directory.
$3
`bash
progga /path/to/project
`
$3
`bash
progga . my-ai-context.md
`
---
How Progga Works (Short Example)
Given a project like:
`
my-app/
├── src/
│ └── index.js
├── package.json
├── node_modules/
└── build/
`
Progga generates a single Markdown file containing:
* A clean folder tree (excluding node_modules, build, etc.)
* The contents of relevant source files
* Proper code blocks with language hints
Example output structure:
``markdown
Project Documentation: my-app
Folder Structure
my-app/
├── src/
│ └── index.js
├── package.json
File Contents
$3
`js
// file content here
``
You can upload this file directly to an AI and ask questions about the project.
Project Presets
Progga supports project-type presets that control what files are included.
Currently supported:
- generic (default)
- flutter (Android, iOS, Web, Windows, macOS, Linux)
If no preset is provided, Progga attempts to detect the project type and asks which preset to use.
`bash
progga --preset flutter
```