https://github.com/gs0ciety/dump-code
A simple Bash script to export entire repositories into a single Markdown file. Perfect for summarizing codebases or feeding them into LLMs for analysis!
https://github.com/gs0ciety/dump-code
bash cli-tool code-analysis developer-tools documentation linux markdown open-source shell-script
Last synced: 2 months ago
JSON representation
A simple Bash script to export entire repositories into a single Markdown file. Perfect for summarizing codebases or feeding them into LLMs for analysis!
- Host: GitHub
- URL: https://github.com/gs0ciety/dump-code
- Owner: gs0ciety
- License: mit
- Created: 2025-04-01T20:30:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-12T01:37:41.000Z (about 1 year ago)
- Last Synced: 2025-04-12T02:45:06.304Z (about 1 year ago)
- Topics: bash, cli-tool, code-analysis, developer-tools, documentation, linux, markdown, open-source, shell-script
- Language: Shell
- Homepage: https://www.gsociety.com.ar
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dump-code 📝
> A simple Bash script to export an entire repository's codebase into a single Markdown file. Ideal for feeding into language models (LLMs) for analysis, summarization, or processing.
[](https://opensource.org/licenses/MIT)
[](https://shields.io/)
[](https://www.gnu.org/software/bash/)
## Features
- 🔍 **Recursive Code Extraction:** Scans the provided repository directory recursively.
- 🛡️ **Exclusion Filters:** Ignores specific files, directories, and file types.
- 🔒 **Prevents Self-Inclusion:** Avoids infinite loops by skipping the output file if it's within the source directory.
- 📄 **Flexible Output:** Generates the output file at a specified path or defaults to `dump.md` in the current working directory.
## Installation
### Using Make (Recommended)
If you have `make` installed, you can install **dump-code** system-wide by running:
```bash
git clone https://github.com/gs0ciety/dump-code.git
cd dump-code
sudo make install
```
This command copies the script to `/usr/local/bin/dump-code` and sets the proper executable permissions. **The `sudo` command is required** because writing to `/usr/local/bin/` requires superuser privileges.
### Manual Installation
If you prefer not to use `make`, follow these steps:
1. Clone the repository or download the `dump-code` script.
2. Copy the script to a directory in your `PATH` (e.g., `/usr/local/bin/`):
```bash
sudo cp bin/dump-code /usr/local/bin/dump-code
```
3. Make the script executable:
```bash
sudo chmod +x /usr/local/bin/dump-code
```
## Usage
The **dump-code** command accepts the following parameters:
```bash
dump-code [output_file.md]
```
- ``: The directory containing the repository you want to export.
- `[output_file.md]`: *(Optional)* The destination file for the output. If omitted, a file named `dump.md` will be created in the current working directory.
### Examples
- Export code to a custom output file:
```bash
dump-code /path/to/repo /path/to/output/output.md
```
- Export code using the default output filename (`dump.md`):
```bash
dump-code /path/to/repo
```
---
## 🔨 Customizing Ignored Files, Directories, and Extensions
By default, the script ignores certain files, directories, and file extensions to avoid including unnecessary content in the Markdown export. You can **modify these lists directly within the script** by editing the following variables:
### Ignored Files
These files will be skipped regardless of their location in the repository:
```bash
local ignore_files=("package-lock.json" "yarn.lock" ".DS_Store")
```
To **add more files**, simply include them in the list:
```bash
local ignore_files=("package-lock.json" "yarn.lock" ".DS_Store" "README.md" "LICENSE")
```
---
### Ignored Directories
These directories and their contents are ignored recursively:
```bash
local ignore_dirs=(".git" "node_modules" "dist" "build" ".next" ".expo" "fonts" "docs")
```
To **add or remove directories**, edit this list. For example, to ignore `test` and `coverage` folders:
```bash
local ignore_dirs=(".git" "node_modules" "dist" "build" ".next" ".expo" "fonts" "docs" "test" "coverage")
```
---
### Ignored Extensions
These file types will be excluded from the Markdown output:
```bash
local ignore_extensions=("png" "jpg" "jpeg" "gif" "svg" "ico" "webp" "bmp" "tiff")
```
To **add new extensions**, simply include them in the list. For example, to also ignore `.mp4` and `.zip` files:
```bash
local ignore_extensions=("png" "jpg" "jpeg" "gif" "svg" "ico" "webp" "bmp" "tiff" "mp4" "zip")
```
---
## How It Works
- **Directory Scanning:** The script uses the `find` command to locate all files in the provided source directory.
- **Exclusion Rules:** It filters out specific files, directories, and file types as defined above.
- **Markdown Formatting:** For each file processed, the script adds a header with the file name and path, and wraps the file’s contents in Markdown code blocks.
- **Self-Exclusion:** It checks and skips the output file if it resides within the source directory to avoid recursive inclusion.
## Uninstallation
If you installed the script using the Makefile, you can remove it by running:
```bash
sudo make uninstall
```
This command removes **dump-code** from `/usr/local/bin/dump-code`. **The `sudo` command is required** because removing a file from `/usr/local/bin/` requires superuser privileges.
## Contributing
Contributions, improvements, and suggestions are welcome! To contribute:
1. Fork this repository.
2. Clone your forked repository.
3. Create a new branch (`git checkout -b feature/YourFeature`).
4. Commit your changes (`git commit -m 'Add new feature'`).
5. Push to your branch (`git push origin feature/YourFeature`).
6. Open a Pull Request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contact
Feel free to reach out via:
- GitHub: [gs0ciety](https://github.com/gs0ciety)