@sapirrior/codefile
v1.0.0
Published
Pack a project directory into a single structured text file for LLM context.
Downloads
14
Maintainers
Readme
CodeFile
A lightweight TypeScript tool to bundle a project directory into a single structured text file. Designed to provide comprehensive context for AI models with limited file upload capabilities and to facilitate easy project reconstruction.
Features
- Project Bundling: Packs all project files (respecting
.gitignore) into one.txtfile. - Reconstruction: Rebuilds the entire project structure from the bundle.
- Visual Tree: Generates a clear file structure overview in the output.
- Binary Detection: Automatically identifies and marks binary, empty, and symbolic link files.
Installation
To install CodeFile from anywhere in your terminal:
npm install -g sapirrior/codefile-nodePer-Project Installation
npm install sapirrior/codefile-nodeUsage
If installed globally:
codefile [directory] [-o output.txt]If installed per-project:
./node_modules/.bin/codefile [directory] [-o output.txt]Options
-b, --build: Reconstruct project from a pack file.-o, --output: Specify output path for packing or input path for building.-h, --help: Show help information.
License
MIT
