Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
51 changes: 14 additions & 37 deletions .claude/skills/repomix-explorer/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,32 +44,10 @@ The user might ask in various ways:
- Local directory: `npx repomix@latest [directory]`
- Choose output format (xml is default and recommended)
- Decide if compression is needed (for repos >100k lines)
3. **Execute the repomix command** via Bash tool
4. **Analyze the generated output** using Grep and Read tools
3. **Execute the repomix command** via shell
4. **Analyze the generated output** using pattern search and file reading
5. **Provide clear insights** with actionable recommendations

## Available Tools

### Bash Tool
Run repomix commands and shell utilities:
```bash
npx repomix@latest --remote yamadashy/repomix
npx repomix@latest ./src
grep -i "pattern" repomix-output.xml
```

### Grep Tool
Search patterns in output files (preferred over bash grep):
- Use for finding code patterns, functions, imports
- Supports context lines (-A, -B, -C equivalents)
- More efficient than bash grep for large files

### Read Tool
Read specific sections of output files:
- Use offset/limit for large files
- Read file tree section first for structure overview
- Read specific file contents as needed

## Workflow

### Step 1: Pack the Repository
Expand Down Expand Up @@ -125,20 +103,20 @@ Always note the output file location for the next steps.
### Step 3: Analyze the Output File

**Start with structure overview:**
1. Use Grep or Read tool to view file tree (usually near the beginning)
1. Search for file tree section (usually near the beginning)
2. Check metrics summary for overall statistics

**Search for patterns:**
```bash
# Using Grep tool (preferred)
# Pattern search (preferred for large files)
grep -iE "export.*function|export.*class" repomix-output.xml

# Using bash grep with context
# Search with context
grep -iE -A 5 -B 5 "authentication|auth" repomix-output.xml
```

**Read specific sections:**
Use Read tool with offset/limit for large files, or read entire file if small.
Read files with offset/limit for large outputs, or read entire file if small.

### Step 4: Provide Insights

Expand All @@ -151,7 +129,7 @@ Use Read tool with offset/limit for large files, or read entire file if small.

### Efficiency
1. **Always use `--compress` for large repos** (>100k lines)
2. **Use Grep tool first** before reading entire files
2. **Use pattern search (grep) first** before reading entire files
3. **Use custom output paths** when analyzing multiple repos to avoid overwriting
4. **Clean up output files** after analysis if they're very large

Expand Down Expand Up @@ -226,7 +204,7 @@ Your workflow:
1. Run: npx repomix@latest (or --remote if specified)
2. Grep: grep -iE -A 5 -B 5 "auth|authentication|login|password" repomix-output.xml
3. Analyze matches and categorize by file
4. Use Read tool to get more context if needed
4. Read the file to get more context if needed
5. Report:
"Authentication-related code found in the following files:
- [file1]: [description]
Expand All @@ -239,7 +217,7 @@ User: "Explain the structure of this project"

Your workflow:
1. Run: npx repomix@latest ./
2. Read file tree from output (use Read tool with limit if needed)
2. Read file tree from output (use limit if file is large)
3. Grep for main entry points: grep -iE "index|main|app" repomix-output.xml
4. Grep for exports: grep "export" repomix-output.xml | head -20
5. Provide structural overview with ASCII diagram if helpful
Expand Down Expand Up @@ -301,19 +279,18 @@ If you need more information:

## Important Notes

1. **Don't use MCP tools**: This agent uses repomix CLI commands directly via Bash tool
2. **Output file management**: Track where files are created, clean up if needed
3. **Token efficiency**: Use `--compress` for large repos to reduce token usage
4. **Incremental analysis**: Don't read entire files at once; use grep first
5. **Security**: Repomix automatically excludes sensitive files; trust its security checks
1. **Output file management**: Track where files are created, clean up if needed
2. **Token efficiency**: Use `--compress` for large repos to reduce token usage
3. **Incremental analysis**: Don't read entire files at once; use grep first
4. **Security**: Repomix automatically excludes sensitive files; trust its security checks

## Self-Verification Checklist

Before completing your analysis:

- Did you run the repomix command successfully?
- Did you note the metrics from command output?
- Did you use Grep tool efficiently before reading large sections?
- Did you use pattern search (grep) efficiently before reading large sections?
- Are your insights based on actual data from the output?
- Have you provided file paths and line numbers for references?
- Did you suggest logical next steps for deeper exploration?
Expand Down
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1193,6 +1193,38 @@ repomix --skill-generate --compress
repomix --remote yamadashy/repomix --skill-generate
```

### Repomix Explorer Skill (Agent Skills)

Repomix provides a ready-to-use **Repomix Explorer** skill that enables AI coding assistants to analyze and explore codebases using Repomix CLI. This skill is designed to work with various AI tools including Claude Code, Cursor, Codex, GitHub Copilot, and more.

#### Quick Install

```bash
npx add-skill yamadashy/repomix --skill repomix-explorer
```

This command installs the skill to your AI assistant's skills directory (e.g., `.claude/skills/`), making it immediately available.

#### What It Does

Once installed, you can analyze codebases with natural language instructions.

Analyze remote repositories:

```text
"What's the structure of this repo?
https://github.com/facebook/react"
```

Explore local codebases:

```text
"What's in this project?
~/projects/my-app"
```

This is useful not only for understanding codebases, but also when you want to implement features by referencing your other repositories.

## ⚙️ Configuration

Repomix supports multiple configuration file formats for flexibility and ease of use.
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configDe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configDe = defineConfig({
{ text: 'MCP-Server', link: '/de/guide/mcp-server' },
{ text: 'Claude Code Plugins', link: '/de/guide/claude-code-plugins' },
{ text: 'Agent Skills Generierung', link: '/de/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/de/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/de/guide/github-actions' },
{ text: 'Repomix als Bibliothek verwenden', link: '/de/guide/development/using-repomix-as-a-library' },
{ text: 'KI-unterstützte Entwicklungstipps', link: '/de/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configEnUs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configEnUs = defineConfig({
{ text: 'MCP Server', link: '/guide/mcp-server' },
{ text: 'Claude Code Plugins', link: '/guide/claude-code-plugins' },
{ text: 'Agent Skills Generation', link: '/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/guide/github-actions' },
{ text: 'Using Repomix as a Library', link: '/guide/development/using-repomix-as-a-library' },
{ text: 'AI-Assisted Development Tips', link: '/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configEs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configEs = defineConfig({
{ text: 'Servidor MCP', link: '/es/guide/mcp-server' },
{ text: 'Plugins de Claude Code', link: '/es/guide/claude-code-plugins' },
{ text: 'Generación de Agent Skills', link: '/es/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/es/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/es/guide/github-actions' },
{ text: 'Usar Repomix como Biblioteca', link: '/es/guide/development/using-repomix-as-a-library' },
{ text: 'Consejos para Desarrollo Asistido por IA', link: '/es/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configFr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configFr = defineConfig({
{ text: 'Serveur MCP', link: '/fr/guide/mcp-server' },
{ text: 'Plugins Claude Code', link: '/fr/guide/claude-code-plugins' },
{ text: "Génération d'Agent Skills", link: '/fr/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/fr/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/fr/guide/github-actions' },
{
text: 'Utiliser Repomix comme bibliothèque',
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configHi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configHi = defineConfig({
{ text: 'MCP सर्वर', link: '/hi/guide/mcp-server' },
{ text: 'Claude Code प्लगइन्स', link: '/hi/guide/claude-code-plugins' },
{ text: 'Agent Skills जनरेशन', link: '/hi/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/hi/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/hi/guide/github-actions' },
{ text: 'Repomix को लाइब्रेरी के रूप में उपयोग', link: '/hi/guide/development/using-repomix-as-a-library' },
{ text: 'AI-सहायक विकास टिप्स', link: '/hi/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configId.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configId = defineConfig({
{ text: 'Server MCP', link: '/id/guide/mcp-server' },
{ text: 'Plugin Claude Code', link: '/id/guide/claude-code-plugins' },
{ text: 'Pembuatan Agent Skills', link: '/id/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/id/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/id/guide/github-actions' },
{
text: 'Menggunakan Repomix sebagai Library',
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configIt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configIt = defineConfig({
{ text: 'Server MCP', link: '/it/guide/mcp-server' },
{ text: 'Plugin Claude Code', link: '/it/guide/claude-code-plugins' },
{ text: 'Generazione Agent Skills', link: '/it/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/it/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/it/guide/github-actions' },
{
text: 'Utilizzare Repomix come Libreria',
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configJa.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configJa = defineConfig({
{ text: 'MCPサーバー', link: '/ja/guide/mcp-server' },
{ text: 'Claude Codeプラグイン', link: '/ja/guide/claude-code-plugins' },
{ text: 'Agent Skills生成', link: '/ja/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/ja/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/ja/guide/github-actions' },
{ text: 'ライブラリとしての使用', link: '/ja/guide/development/using-repomix-as-a-library' },
{ text: 'AI支援開発のヒント', link: '/ja/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configKo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configKo = defineConfig({
{ text: 'MCP 서버', link: '/ko/guide/mcp-server' },
{ text: 'Claude Code 플러그인', link: '/ko/guide/claude-code-plugins' },
{ text: 'Agent Skills 생성', link: '/ko/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/ko/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/ko/guide/github-actions' },
{ text: 'Repomix를 라이브러리로 사용하기', link: '/ko/guide/development/using-repomix-as-a-library' },
{ text: 'AI 지원 개발 팁', link: '/ko/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configPtBr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configPtBr = defineConfig({
{ text: 'Servidor MCP', link: '/pt-br/guide/mcp-server' },
{ text: 'Plugins do Claude Code', link: '/pt-br/guide/claude-code-plugins' },
{ text: 'Geração de Agent Skills', link: '/pt-br/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/pt-br/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/pt-br/guide/github-actions' },
{ text: 'Usando Repomix como Biblioteca', link: '/pt-br/guide/development/using-repomix-as-a-library' },
{ text: 'Dicas de Desenvolvimento Assistido por IA', link: '/pt-br/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configRu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configRu = defineConfig({
{ text: 'MCP-сервер', link: '/ru/guide/mcp-server' },
{ text: 'Плагины Claude Code', link: '/ru/guide/claude-code-plugins' },
{ text: 'Генерация Agent Skills', link: '/ru/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/ru/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/ru/guide/github-actions' },
{ text: 'Использование Repomix как библиотеки', link: '/ru/guide/development/using-repomix-as-a-library' },
{ text: 'Лучшие практики разработки с ИИ', link: '/ru/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configVi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configVi = defineConfig({
{ text: 'Máy chủ MCP', link: '/vi/guide/mcp-server' },
{ text: 'Plugin Claude Code', link: '/vi/guide/claude-code-plugins' },
{ text: 'Tạo Agent Skills', link: '/vi/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/vi/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/vi/guide/github-actions' },
{
text: 'Sử dụng Repomix như một thư viện',
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configZhCn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export const configZhCn = defineConfig({
{ text: 'MCP 服务器', link: '/zh-cn/guide/mcp-server' },
{ text: 'Claude Code 插件', link: '/zh-cn/guide/claude-code-plugins' },
{ text: 'Agent Skills 生成', link: '/zh-cn/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/zh-cn/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/zh-cn/guide/github-actions' },
{ text: '作为库使用 Repomix', link: '/zh-cn/guide/development/using-repomix-as-a-library' },
{ text: 'AI辅助开发技巧', link: '/zh-cn/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configZhTw.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const configZhTw = defineConfig({
{ text: 'MCP 伺服器', link: '/zh-tw/guide/mcp-server' },
{ text: 'Claude Code 外掛', link: '/zh-tw/guide/claude-code-plugins' },
{ text: 'Agent Skills 生成', link: '/zh-tw/guide/agent-skills-generation' },
{ text: 'Repomix Explorer Skill', link: '/zh-tw/guide/repomix-explorer-skill' },
{ text: 'GitHub Actions', link: '/zh-tw/guide/github-actions' },
{ text: '作為庫使用 Repomix', link: '/zh-tw/guide/development/using-repomix-as-a-library' },
{ text: 'AI輔助開發技巧', link: '/zh-tw/guide/tips/best-practices' },
Expand Down
84 changes: 84 additions & 0 deletions website/client/src/de/guide/repomix-explorer-skill.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Repomix Explorer Skill (Agent Skills)

Repomix bietet einen sofort einsatzbereiten **Repomix Explorer** Skill, der KI-Codierungsassistenten ermöglicht, Codebasen mit der Repomix CLI zu analysieren und zu erkunden.

Dieser Skill ist für verschiedene KI-Tools konzipiert, darunter Claude Code, Cursor, Codex, GitHub Copilot und mehr.

## Schnellinstallation

```bash
npx add-skill yamadashy/repomix --skill repomix-explorer
```

Dieser Befehl installiert den Skill in das Skills-Verzeichnis Ihres KI-Assistenten (z.B. `.claude/skills/`) und macht ihn sofort verfügbar.

## Was er kann

Nach der Installation können Sie Codebasen mit natürlichen Sprachanweisungen analysieren.

#### Remote-Repositories analysieren

```text
"What's the structure of this repo?
https://github.com/facebook/react"
```

#### Lokale Codebasen erkunden

```text
"What's in this project?
~/projects/my-app"
```

Dies ist nicht nur nützlich zum Verstehen von Codebasen, sondern auch wenn Sie Features implementieren möchten, indem Sie Ihre anderen Repositories als Referenz verwenden.

## Funktionsweise

Der Repomix Explorer Skill führt KI-Assistenten durch den kompletten Workflow:

1. **Repomix-Befehle ausführen** - Repositories in KI-freundliches Format packen
2. **Ausgabedateien analysieren** - Mustersuche (grep) verwenden, um relevanten Code zu finden
3. **Erkenntnisse liefern** - Struktur, Metriken und umsetzbare Empfehlungen berichten

## Anwendungsbeispiele

### Eine neue Codebasis verstehen

```text
"I want to understand the architecture of this project.
https://github.com/vercel/next.js"
```

Die KI führt repomix aus, analysiert die Ausgabe und liefert einen strukturierten Überblick über die Codebasis.

### Bestimmte Muster finden

```text
"Find all authentication-related code in this repository."
```

Die KI sucht nach Authentifizierungsmustern, kategorisiert Funde nach Datei und erklärt, wie die Authentifizierung implementiert ist.

### Eigene Projekte referenzieren

```text
"I want to implement a similar feature to what I did in my other project.
~/projects/my-other-app"
```

Die KI analysiert Ihr anderes Repository und hilft Ihnen, Ihre eigenen Implementierungen als Referenz zu nutzen.

## Skill-Inhalt

Der Skill enthält:

- **Benutzerabsichtserkennung** - Versteht verschiedene Arten, wie Benutzer nach Codebasis-Analysen fragen
- **Repomix-Befehlsanleitung** - Weiß, welche Optionen zu verwenden sind (`--compress`, `--include`, etc.)
- **Analyse-Workflow** - Strukturierter Ansatz zur Erkundung gepackter Ausgaben
- **Best Practices** - Effizienztipps wie grep vor dem Lesen ganzer Dateien zu verwenden

## Verwandte Ressourcen

- [Agent Skills Generation](/de/guide/agent-skills-generation) - Eigene Skills aus Codebasen generieren
- [Claude Code Plugins](/de/guide/claude-code-plugins) - Repomix-Plugins für Claude Code
- [MCP Server](/de/guide/mcp-server) - Alternative Integrationsmethode
Loading
Loading