Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 3.3 KB

README.md

File metadata and controls

81 lines (53 loc) · 3.3 KB

Repomix Runner Repomix logo

You can support this project by giving a star on GitHub ! ⭐️ 🔭 🙏

GitHub Version Installs License: MIT

Repomix Runner is a VSCode extension that allows you to easily bundle files into a single output for AI processing. It uses the great Repomix tool.

✨ Features

  • 📁 Pack your selection of files into a single output for AI processing.
  • 📦 Create reusable bundles for parts of your project you frequently package.
  • 📎 Two copy modes for clipboard: content or file. -> you can paste a whole file not just content.
  • 🗑️ Optional output file cleanup. -> But you still have it in clipboard! 😀
  • 🛠️ Easy settings in vscode and/or support a repomix.config.json file.

📖 Usage

With the REPOMIX custom view, all is in one place 🎉 :

(keep in mind the output-file is also in your clipboard).

repomix-demo.mp4

Or you can use the commands ⬇️

⚙️ Commands

Open the palette with Cmd+Shift+P or Ctrl+Shift+P then:

  • Repomix Run to run repomix on the root folder of your project
  • Repomix Run On Open Files to run repomix on the open files
  • Repomix Run On Selection to run repomix on the selected files or directories
  • Repomix Run Bundle to select a bundle to run
  • Repomix Manage Bundles to edit or delete your bundles
  • Repomix Settings for a quick access to the settings
  • Repomix Output to open the repomix output channel

🚀 Installation

  1. Open VS Code
  2. Press Cmd+P (macOS) or Ctrl+P (Windows/Linux)
  3. Type ext install DorianMassoulier.repomix-runner
  4. Press Enter

🛠️ Configuration

  • The extension support the repomix.config.json file in your project root folder, it will override the settings in the extension. Except for the runner settings.

📋 Requirements

  • VS Code 1.93.0 or higher
  • Node.js and npm installed (for npx)
  • macOS for file copy mode
  • xclip installed for file copy mode on linux

⚠️ Known Issues

  • File copy mode is only available on macOS and linux (you need to install xclip for file copy mode on linux)

🤝 Contributing

Any feedback, issue or feature request is much appreciated !

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for details.