Skip to content

sapirrior/codefile-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 .txt file.
  • 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-node

Per-Project Installation

npm install sapirrior/codefile-node

Usage

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

About

Pack your codes in one single ai friendly context file. Now in nodejs

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors