Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

5 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“„ CodeDump - Code Documentation Tool

License: MIT Python 3.8+ Bash Platform

A professional tool for automatically extracting all text files from your projects and converting them into a unified report. Perfect for sending code to ChatGPT, Claude, and other LLMs, documenting entire projects, and automatic code backups.

โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ          CODE DUMP - DUAL MODE                    โ”ƒ
โ”—โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”›

โœจ Features

Feature Description
โœ… Multi-Project Support Process several projects simultaneously
โœ… JSON Configuration Advanced settings with validation
โœ… Headless Mode Automatic execution without user input
โœ… Auto Backup Timestamped backups with retention policy
โœ… 20+ File Formats Support for all major code file types
โœ… Filter System Exclude directories, files, and patterns
โœ… Markdown Output Standard format with syntax highlighting
โœ… Cross-Platform Linux, macOS, and Windows (WSL)

๐Ÿš€ Quick Start

Installation

# Clone the repository
git clone https://github.com/esmaeil-ahmadipour/text-extractor.git
cd text-extractor

# Make scripts executable
chmod +x bin.sh code_dump.py

# Install jq (required for config validation)
# Ubuntu/Debian: sudo apt install jq
# macOS: brew install jq

# Run the tool
./bin.sh

Basic Usage

# Mode 1: Process ./code or ./CODE folder (simple)
./bin.sh
# Then select option 1

# Mode 2: Process projects from settings.json (advanced)
./bin.sh
# Then select option 2

๐Ÿ“Š Supported File Extensions

Category Extensions
Mobile .dart, .java, .kt, .swift
Web .js, .ts, .jsx, .tsx, .html, .css
Backend .py, .sh, .bat, .ps1
Data .json, .yaml, .yml, .xml
Docs .md, .txt, .rst

๐ŸŽฎ Two Operation Modes

Mode Input Config Required Backup Output
Mode 1 ./code or ./CODE folder No No code_report.txt
Mode 2 settings.json projects Yes (with jq) Yes code_report_{name}.txt

๐Ÿ“ Output Structure

text-extractor/
โ”œโ”€โ”€ bin.sh                              # Main script (dual mode)
โ”œโ”€โ”€ code_dump.py                        # Python engine
โ”œโ”€โ”€ settings.json                       # Configuration (required for Mode 2)
โ”œโ”€โ”€ code/                               # Mode 1 input folder (or CODE/Code)
โ”œโ”€โ”€ code_report.txt                     # Mode 1 output
โ”œโ”€โ”€ code_report_Sample.txt              # Mode 2 output for Sample project
โ”œโ”€โ”€ code_report_Resume.txt              # Mode 2 output for Resume project
โ””โ”€โ”€ backup/                             # Automatic backups (Mode 2 only)
    โ”œโ”€โ”€ Sample_2026-05-20_22-06-17.txt
    โ””โ”€โ”€ Resume_2026-05-20_22-06-18.txt

๐Ÿ”ง System Requirements

Requirement Minimum Recommended
OS Linux/macOS/WSL Ubuntu 20.04+
Python 3.8+ 3.10+
Bash 4.0+ 5.0+
jq Required (Mode 2) 1.6+
RAM 256 MB 512 MB
Disk 50 MB 100 MB

๐Ÿ’ก Example Output

๐Ÿ“ฆ Generated by CodeDump
๐Ÿ”— GitHub: https://github.com/esmaeil-ahmadipour/CodeDump
โญ Star this repo if it helped you!

# PROJECT: Sample


# PATH: /home/user/projects/sample

# Generated: 2026-05-20 22:06:17.053321

#----------------------------------------------------------------------

---

/_
FILE: src/main.js
SIZE: 2.5 KB
_/

console.log("Hello World");

โœ… Configuration Validation

Mode 2 automatically validates your settings.json:

  • โœ“ Valid JSON syntax
  • โœ“ Required projects array exists
  • โœ“ At least one enabled project
  • โœ“ Project paths exist (warns if missing)

๐Ÿ“ˆ Performance

Speed: ~1000 files/second (depends on file size)

Memory: ~50 MB for 10,000 files

Concurrency: Sequential processing (configurable)

๐Ÿ”’ Security

No external API calls

Local processing only

No data collection

Open source auditability

๐Ÿค Contributing

Fork the repository

Create a feature branch

Commit your changes

Push to the branch

Open a Pull Request

๐Ÿ“„ License

MIT License - Free for any use

๐Ÿ‘ค Author

Esmaeil Ahmadipour

Email: software686@gmail.com

GitHub: @esmaeil-ahmadipour

LinkedIn: esmaeil-ahmadipour

Portfolio: https://ea2.ir Website: https://tarvix.org

โญ Star on GitHub

If this tool helps you, please give it a star on GitHub!

๐Ÿ“– Installation Guide | โš™๏ธ Configuration | ๐Ÿ“š API Reference

About

CodeDump extracts all text files from your projects into a unified report. Perfect for sending code to ChatGPT/Claude, creating documentation, and automated backups.

Resources

Code of conduct

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages