1.0.1 โข Published 5 months ago
repo-prompt v1.0.1
repo-prompt
A CLI tool to generate AI prompts from GitHub repositories using repomix.
Features
- ๐ Clone any GitHub repository (supports both HTTPS and SSH URLs)
- ๐ฒ Support for specific branches or tags
- ๐ Filter files using glob patterns
- ๐ซ Ignore unwanted files and directories
- ๐ Generate structured prompts for AI consumption
- ๐งน Automatic cleanup of temporary files
Usage
The easiest way to use repo-prompt is with npx:
npx -y repo-prompt --repo <github-repo-url> [options]
Examples
Basic usage with default settings:
npx -y repo-prompt --repo https://github.com/username/repo
Clone a specific branch and include only TypeScript files:
npx -y repo-prompt --repo https://github.com/username/repo/tree/dev --include "**/*.ts" "**/*.tsx"
Include specific files and ignore test files:
npx -y repo-prompt --repo https://github.com/username/repo \
--include "**/*.js" "**/*.jsx" \
--ignore "**/test/**" "**/node_modules/**"
Options
--repo <url>
(required): GitHub repository URL (HTTPS or SSH)--output [filename]
(optional): Output file name (default: repo-prompt.txt)--include <glob...>
(optional): Files to include (can specify multiple patterns)--ignore <glob...>
(optional): Files to ignore (can specify multiple patterns)
Installation
While npx is recommended, you can also install globally:
npm install -g repo-prompt
Then use it as:
repo-prompt --repo <github-repo-url> [options]
License
MIT ยฉ ChenCheng