Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![npm](https://img.shields.io/npm/l/repomix.svg?maxAge=1000)](https://github.com/yamadashy/repomix/blob/main/LICENSE)
[![node](https://img.shields.io/node/v/repomix.svg?maxAge=1000)](https://www.npmjs.com/package/repomix)

Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file.
Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file.
Comment thread
yamadashy marked this conversation as resolved.
Outdated
It is perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, and Gemini.

## 📢 Important Notice: Project Renamed to Repomix
Expand All @@ -32,7 +32,7 @@ npm uninstall -g repopack
```

#### Configuration Files
Your existing configuration files (`repopack.config.json` and `.repopackignore`) will continue to work during the transition period.
Your existing configuration files (`repopack.config.json` and `.repopackignore`) will continue to work during the transition period.
Comment thread
yamadashy marked this conversation as resolved.
Outdated
`repomix` will automatically detect these files and offer to migrate them to the new format (`repomix.config.json` and `.repomixignore`).

#### Timeline
Expand Down Expand Up @@ -173,7 +173,7 @@ Feel free to join the discussion and share your own experiences! Your insights c

### Output File Format

Repomix generates a single file with clear separators between different parts of your codebase.
Repomix generates a single file with clear separators between different parts of your codebase.
Comment thread
yamadashy marked this conversation as resolved.
Outdated
To enhance AI comprehension, the output file begins with an AI-oriented explanation, making it easier for AI models to understand the context and structure of the packed repository.

#### Plain Text Format (default)
Expand Down Expand Up @@ -258,7 +258,7 @@ src/
</instruction>
```

For those interested in the potential of XML tags in AI contexts:
For those interested in the potential of XML tags in AI contexts:
Comment thread
yamadashy marked this conversation as resolved.
Outdated
Comment thread
yamadashy marked this conversation as resolved.
Outdated
https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags

> When your prompts involve multiple components like context, instructions, and examples, XML tags can be a game-changer. They help Claude parse your prompts more accurately, leading to higher-quality outputs.
Expand Down Expand Up @@ -314,6 +314,7 @@ This format provides a clean, readable structure that is both human-friendly and
- `--style <style>`: Specify the output style (`plain`, `xml`, `markdown`)
- `--top-files-len <number>`: Number of top files to display in the summary
- `--output-show-line-numbers`: Show line numbers in the output
- `--copy`: Additionally copy generated output to system clipboard
- `--remote <url>`: Process a remote Git repository
- `--verbose`: Enable verbose logging

Expand Down Expand Up @@ -377,6 +378,7 @@ Here's an explanation of the configuration options:
|`output.removeComments`| Whether to remove comments from supported file types | `false` |
|`output.removeEmptyLines`| Whether to remove empty lines from the output | `false` |
|`output.showLineNumbers`| Whether to add line numbers to each line in the output |`false`|
|`output.copyToClipboard`| Whether to copy the output to system clipboard in addition to saving the file |`false`|
|`output.topFilesLength`| Number of top files to display in the summary. If set to 0, no summary will be displayed |`5`|
|`include`| Patterns of files to include (using [glob patterns](https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#pattern-syntax)) |`[]`|
|`ignore.useGitignore`| Whether to use patterns from the project's `.gitignore` file |`true`|
Expand All @@ -395,6 +397,7 @@ Example configuration:
"removeComments": false,
"removeEmptyLines": false,
"showLineNumbers": false,
"copyToClipboard": true,
"topFilesLength": 5
},
"include": ["**/*"],
Expand All @@ -411,7 +414,7 @@ Example configuration:

### Global Configuration
To create a global configuration file:

```bash
repomix --init --global
```
Expand Down Expand Up @@ -481,7 +484,7 @@ Here's an example of how you might use this feature:

When Repomix generates the output, it will include the contents of `repomix-instruction.md` in a dedicated section.

Note: The instruction content is appended at the end of the output file. This placement can be particularly effective for AI systems. For those interested in understanding why this might be beneficial, Anthropic provides some insights in their documentation:
Note: The instruction content is appended at the end of the output file. This placement can be particularly effective for AI systems. For those interested in understanding why this might be beneficial, Anthropic provides some insights in their documentation:
Comment thread
yamadashy marked this conversation as resolved.
Outdated
https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/long-context-tips

> Put long-form data at the top: Place your long documents and inputs (~20K+ tokens) near the top of your prompt, above your query, instructions, and examples. This can significantly improve Claude's performance across all models.
Expand All @@ -491,7 +494,7 @@ https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/long-con

When `output.removeComments` is set to `true`, Repomix 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:
Supported languages include:
Comment thread
yamadashy marked this conversation as resolved.
Outdated
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.
Expand Down Expand Up @@ -530,7 +533,7 @@ By default, Repomix's security check feature is enabled. You can disable it by s

## 🤝 Contribution

We welcome contributions from the community! To get started, please refer to our [Contributing Guide](CONTRIBUTING.md).
We welcome contributions from the community! To get started, please refer to our [Contributing Guide](CONTRIBUTING.md).

### Contributors

Expand Down
Loading