diff --git a/README.md b/README.md index 440c42026..d1f277e2d 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,21 @@ repomix That's it! Repomix will generate a `repomix-output.txt` file in your current directory, containing your entire repository in an AI-friendly format. +You can then send this file to an AI assistant with a prompt like: + +``` +This file contains all the files in the repository combined into one. +I want to refactor the code, so please review it first. +``` + +![Repomix File Usage 1](website/client/public/images/docs/repomix-file-usage-1.png) + +When you propose specific changes, the AI might be able to generate code accordingly. With features like Claude's Artifacts, you could potentially output multiple files, allowing for the generation of multiple interdependent pieces of code. + +![Repomix File Usage 2](website/client/public/images/docs/repomix-file-usage-2.png) + +Happy coding! 🚀 + ### Using The Website 🌐 Want to try it quickly? Visit the official website at [repomix.com](https://repomix.com). Simply enter your repository name, fill in any optional details, and click the **Pack** button to see your generated output. diff --git a/website/client/.tool-versions b/website/client/.tool-versions new file mode 100644 index 000000000..a39e0d683 --- /dev/null +++ b/website/client/.tool-versions @@ -0,0 +1 @@ +nodejs 23.6.0 diff --git a/website/client/guide/index.md b/website/client/guide/index.md index 106a52669..aa9a04385 100644 --- a/website/client/guide/index.md +++ b/website/client/guide/index.md @@ -12,6 +12,23 @@ npx repomix That's it! You'll find a `repomix-output.txt` file containing your entire repository in an AI-friendly format. +You can then send this file to an AI assistant with a prompt like: + +``` +This file contains all the files in the repository combined into one. +I want to refactor the code, so please review it first. +``` + +The AI will analyze your entire codebase and provide comprehensive insights: + +![Repomix File Usage 1](/images/docs/repomix-file-usage-1.png) + +When discussing specific changes, the AI can help generate code. With features like Claude's Artifacts, you can even receive multiple interdependent files: + +![Repomix File Usage 2](/images/docs/repomix-file-usage-2.png) + +Happy coding! 🚀 + ## Core Features - **AI-Optimized Output**: Formats your codebase for easy AI processing diff --git a/website/client/index.md b/website/client/index.md index cb83bed76..aa9e1a22c 100644 --- a/website/client/index.md +++ b/website/client/index.md @@ -26,6 +26,28 @@ features:
+ +## Quick Start + +Once you've generated a packed file (`repomix-output.txt`) using Repomix, you can send it to an AI assistant with a prompt like: + +``` +This file contains all the files in the repository combined into one. +I want to refactor the code, so please review it first. +``` + +The AI will analyze your entire codebase and provide comprehensive insights: + +![Repomix File Usage 1](/images/docs/repomix-file-usage-1.png) + +When discussing specific changes, the AI can help generate code. With features like Claude's Artifacts, you can even receive multiple interdependent files: + +![Repomix File Usage 2](/images/docs/repomix-file-usage-2.png) + +Happy coding! 🚀 + + + ## Power User Guide For advanced users who need more control, Repomix offers extensive customization options through its CLI interface. diff --git a/website/client/public/images/docs/repomix-file-usage-1.png b/website/client/public/images/docs/repomix-file-usage-1.png new file mode 100644 index 000000000..b241b9955 Binary files /dev/null and b/website/client/public/images/docs/repomix-file-usage-1.png differ diff --git a/website/client/public/images/docs/repomix-file-usage-2.png b/website/client/public/images/docs/repomix-file-usage-2.png new file mode 100644 index 000000000..e5ba25eb7 Binary files /dev/null and b/website/client/public/images/docs/repomix-file-usage-2.png differ