Recursively generates comprehensive project snapshots in Markdown format
npm install @rezalabs/project-snapshotRecursively generates comprehensive project snapshots in Markdown format.
- Recursive directory traversal
- .gitignore support
- TypeScript preference over JavaScript
- Path-only mode for binary/asset files
- Token count estimation
- Performance optimized
- Clipboard integration
``bash`
npm install -g @rezalabs/project-snapshot
`bash`
project-snapshot
This generates a PROJECT-SNAPSHOT.md file in the current directory.
`bash
project-snapshot [options]
Options:
-o, --output
-c, --clipboard Copy result to clipboard
--no-gitignore Ignore .gitignore file
--path-only-folders
-v, --verbose Verbose output
--version Show version number
-h, --help Show help
`
Generate snapshot with custom output file:
`bash`
project-snapshot --output my-snapshot.md
Exclude .gitignore:
`bash`
project-snapshot --no-gitignore
Copy to clipboard:
`bash`
project-snapshot --clipboard
Certain folders and file extensions are automatically treated as "path-only", meaning only their existence is documented (not their content):
Default path-only folders: assets, images, public, vendor, lib, bin
Default path-only extensions: .png, .jpg, .jpeg, .gif, .ico, .svg, .pdf, .zip, .tar, .gz, .exe, .dll, .so, .dylib, .class, .pyc
The tool automatically skips .js files if a corresponding .ts` file exists in the same directory.
Contributions are welcome! Please see the main Contributing Guide.
MIT