@rezalabs/project-snapshot

Recursively generates comprehensive project snapshots in Markdown format.

Features

• Recursive directory traversal
• .gitignore support
• TypeScript preference over JavaScript
• Path-only mode for binary/asset files
• Token count estimation
• Performance optimized
• Clipboard integration

Installation

npm install -g @rezalabs/project-snapshot

Usage

Basic Usage

project-snapshot

This generates a PROJECT-SNAPSHOT.md file in the current directory.

Options

project-snapshot [options]

Options:
  -o, --output <file>           Output file (default: PROJECT-SNAPSHOT.md)
  -c, --clipboard               Copy result to clipboard
  --no-gitignore                Ignore .gitignore file
  --path-only-folders <folders>  Additional folders for path-only mode
  -v, --verbose                 Verbose output
  --version                     Show version number
  -h, --help                    Show help

Examples

Generate snapshot with custom output file:

project-snapshot --output my-snapshot.md

Exclude .gitignore:

project-snapshot --no-gitignore

Copy to clipboard:

project-snapshot --clipboard

Features

Path-Only Mode

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

TypeScript Preference

The tool automatically skips .js files if a corresponding .ts file exists in the same directory.

Contributing

Contributions are welcome! Please see the main Contributing Guide.

License

MIT