📦 Repopack

Repopack is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools. It now includes a security check feature to detect potentially sensitive information in your files.

🚀 Features

• AI-Optimized: Formats your codebase in a way that's easy for AI to understand and process.
• Simple to Use: Just one command to pack your entire repository.
• Customizable: Easily configure what to include or exclude.
• Git-Aware: Automatically respects your .gitignore files.
• Security Check: Detects potentially sensitive information in your files.

🛠 Installation

You can install Repopack globally using npm:

npm install -g repopack

Or if you prefer using Yarn:

yarn global add repopack

Alternatively, you can use npx to run Repopack without installing it:

npx repopack

📊 Usage

To pack your entire repository:

repopack

To pack a specific directory:

repopack path/to/directory

Once you have generated the packed file, you can use it with Generative AI tools like Claude or ChatGPT.

Prompt Examples

When using the packed file with AI tools, you can use prompts like these to start your conversation:

English

This file contains the contents of my repository combined into a single file. I'd like to refactor the code, so please review the code first.

Japanese

このファイルはリポジトリのファイルを1つにしたものです。コードのリファクタをしたいのでまずコードを確認してください。

Command Line Options

• -v, --version: Show tool version
• -o, --output <file>: Specify the output file name
• --top-files-len <number>: Number of top files to display in the summary
• -i, --ignore <patterns>: Additional ignore patterns (comma-separated)
• -c, --config <path>: Path to a custom config file
• --verbose: Enable verbose logging

Examples:

repopack -o custom-output.txt
repopack -i "*.log,tmp" -v
repopack -c ./custom-config.json
npx repopack src

🔍 Security Check

Repopack now includes a security check feature that uses SecretLint to detect potentially sensitive information in your files. This feature helps you identify possible security risks before sharing your packed repository.

The security check results will be displayed in the CLI output after the packing process is complete. If any suspicious files are detected, you'll see a list of these files along with a warning message.

Example output:

🔍 Security Check:
──────────────────
2 suspicious file(s) detected:
1. src/config.js
2. tests/testData.json

Please review these files for potential sensitive information.

⚙️ Configuration

Create a repopack.config.json file in your project root for custom configurations. Here's an explanation of the configuration options:

Option	Description	Default
output.filePath	The name of the output file	"repopack-output.txt"
output.headerText	Custom text to include in the file header	null
output.removeComments	Whether to remove comments from supported file types	false
output.topFilesLength	Number of top files to display in the summary. If set to 0, no summary will be displayed	5
ignore.useDefaultPatterns	Whether to use default ignore patterns	true
ignore.customPatterns	Additional patterns to ignore	[]

Example configuration:

{
  "output": {
    "filePath": "repopack-output.txt",
    "headerText": "Custom header information for the packed file.",
    "removeComments": true,
    "topFilesLength": 5
  },
  "ignore": {
    "useDefaultPatterns": true,
    "customPatterns": ["additional-folder", "*.log"]
  }
}

Default Ignore Patterns

Repopack automatically ignores certain files and directories by default:

• All patterns specified in your project's .gitignore file
• Git-related files and directories (e.g., .git, .gitattributes)
• Binary files (e.g., images, executables)
• Common build output and dependency directories (e.g., node_modules, dist)
• System and IDE-specific files (e.g., .DS_Store, .vscode)

This ensures that only relevant source code is included in the packed file. You can add additional ignore patterns using the ignore.customPatterns configuration option or the -i command line flag.

Comment Removal

When output.removeComments is set to true, Repopack will attempt to remove comments from supported file types. This feature can help reduce the size of the output file and focus on the essential code content.

Supported languages include:
HTML, CSS, JavaScript, TypeScript, Vue, Svelte, Python, PHP, Ruby, C, C#, Java, Go, Rust, Swift, Kotlin, Dart, Shell, and YAML.

Note: The comment removal process is conservative to avoid accidentally removing code. In complex cases, some comments might be retained.

📄 Output Format

Repopack generates a single file with clear separators between different parts of your codebase:

================================================================
REPOPACK OUTPUT FILE
================================================================
(Metadata and usage instructions)

================================================================
Repository Files
================================================================

================
File: src/index.js
================
// File contents here

================
File: src/utils.js
================
// File contents here

This format ensures that AI tools can easily distinguish between different files in your codebase.

📜 License

MIT