Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
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
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -658,6 +658,9 @@ Instruction
#### MCP
- `--mcp`: Run as Model Context Protocol server for AI tool integration

#### Agent Skills Generation
- `--skill-generate [name]`: Generate Claude Agent Skills format output to `.claude/skills/<name>/` directory (name auto-generated if omitted)

#### Examples

```bash
Expand Down Expand Up @@ -1099,6 +1102,75 @@ The agent automatically:

For more details, see the plugin documentation in the `.claude/plugins/` directory.

### Agent Skills Generation

Repomix can generate [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills) format output, creating a structured Skills directory that can be used as a reusable codebase reference for AI assistants. This feature is particularly powerful when you want to reference implementations from remote repositories.

#### Basic Usage

```bash
# Generate Skills from local directory
repomix --skill-generate

# Generate with custom Skills name
repomix --skill-generate my-project-reference

# Generate from remote repository
repomix --remote https://github.com/user/repo --skill-generate
```

When you run the command, Repomix prompts you to choose where to save the Skills:

1. **Personal Skills** (`~/.claude/skills/`) - Available across all projects on your machine
2. **Project Skills** (`.claude/skills/`) - Shared with your team via git

#### Generated Structure

The Skills are generated with the following structure:

```text
.claude/skills/<skill-name>/
├── SKILL.md # Main Skills metadata & documentation
└── references/
├── summary.md # Purpose, format, and statistics
├── project-structure.md # Directory tree with line counts
├── files.md # All file contents (grep-friendly)
└── tech-stack.md # Languages, frameworks, dependencies
```
Comment on lines +1132 to +1139
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability in the documentation, please align the comments in the Generated Structure code block. This makes the file structure easier to scan.

Suggested change
.claude/skills/<skill-name>/
├── SKILL.md # Main skill metadata & documentation
└── references/
├── summary.md # Purpose, format, and statistics
├── project-structure.md # Directory tree with line counts
├── files.md # All file contents (grep-friendly)
└── tech-stack.md # Languages, frameworks, dependencies
```
.claude/skills/<skill-name>/
├── SKILL.md # Main skill metadata & documentation
└── references/
├── summary.md # Purpose, format, and statistics
├── project-structure.md # Directory tree with line counts
├── files.md # All file contents (grep-friendly)
└── tech-stack.md # Languages, frameworks, dependencies


#### What's Included

- **SKILL.md**: Contains Skills metadata, file/line/token counts, overview, and usage instructions
- **summary.md**: Explains the Skills' purpose, usage guidelines, and provides statistics breakdown by file type and language
- **project-structure.md**: Directory tree with line counts per file for easy file discovery
- **files.md**: All file contents with syntax highlighting headers, optimized for grep-friendly searching
- **tech-stack.md**: Auto-detected tech stack from dependency files (`package.json`, `requirements.txt`, `Cargo.toml`, etc.)

#### Auto-Generated Skills Names

If no name is provided, Repomix auto-generates one:

```bash
repomix src/ --skill-generate # → repomix-reference-src
repomix --remote user/repo --skill-generate # → repomix-reference-repo
repomix --skill-generate CustomName # → custom-name (normalized to kebab-case)
```

#### Integration with Repomix Features

Skills generation respects all standard Repomix options:

```bash
# Generate Skills with file filtering
repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts"

# Generate Skills with compression
repomix --skill-generate --compress

# Generate Skills from remote repository
repomix --remote yamadashy/repomix --skill-generate
```

## ⚙️ 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 @@ -42,6 +42,7 @@ export const configDe = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configEnUs = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configEs = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configFr = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configHi = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configId = defineConfig({
items: [
{ 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: 'GitHub Actions', link: '/id/guide/github-actions' },
{
text: 'Menggunakan Repomix sebagai Library',
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 @@ -40,6 +40,7 @@ export const configJa = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configKo = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configPtBr = defineConfig({
items: [
{ 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: '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/configVi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export const configVi = defineConfig({
items: [
{ 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: '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 @@ -39,6 +39,7 @@ export const configZhCn = defineConfig({
items: [
{ 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: '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 @@ -42,6 +42,7 @@ export const configZhTw = defineConfig({
items: [
{ 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: '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
213 changes: 213 additions & 0 deletions website/client/src/de/guide/agent-skills-generation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
# Agent Skills Generierung

Repomix kann Ausgaben im Format von [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills) generieren und dabei ein strukturiertes Skills-Verzeichnis erstellen, das als wiederverwendbare Codebase-Referenz für KI-Assistenten dient.

Diese Funktion ist besonders leistungsfähig, wenn Sie Implementierungen aus entfernten Repositories referenzieren möchten. Durch die Generierung von Skills aus Open-Source-Projekten können Sie Claude einfach bitten, spezifische Muster oder Implementierungen zu referenzieren, während Sie an Ihrem eigenen Code arbeiten.

Anstatt eine einzelne gepackte Datei zu generieren, erstellt die Skills-Generierung ein strukturiertes Verzeichnis mit mehreren Referenzdateien, die für KI-Verständnis und grep-freundliche Suche optimiert sind.

> [!NOTE]
> Dies ist eine experimentelle Funktion. Das Ausgabeformat und die Optionen können sich in zukünftigen Versionen basierend auf Benutzer-Feedback ändern.

## Grundlegende Verwendung

Skills aus Ihrem lokalen Verzeichnis generieren:

```bash
# Skills aus dem aktuellen Verzeichnis generieren
repomix --skill-generate

# Mit benutzerdefiniertem Skills-Namen generieren
repomix --skill-generate my-project-reference

# Aus bestimmtem Verzeichnis generieren
repomix path/to/directory --skill-generate

# Aus entferntem Repository generieren
repomix --remote https://github.com/user/repo --skill-generate
```

## Skills-Speicherort-Auswahl

Wenn Sie den Befehl ausführen, fordert Repomix Sie auf, den Speicherort für die Skills zu wählen:

1. **Personal Skills** (`~/.claude/skills/`) - Verfügbar für alle Projekte auf Ihrem Rechner
2. **Project Skills** (`.claude/skills/`) - Mit Ihrem Team über Git geteilt

Wenn das Skills-Verzeichnis bereits existiert, werden Sie aufgefordert, das Überschreiben zu bestätigen.

> [!TIP]
> Wenn Sie Project Skills generieren, sollten Sie diese zur `.gitignore` hinzufügen, um das Committen großer Dateien zu vermeiden:
> ```gitignore
> .claude/skills/repomix-reference-*/
> ```

## Generierte Struktur

Die Skills werden mit folgender Struktur generiert:

```text
.claude/skills/<skill-name>/
├── SKILL.md # Haupt-Skills-Metadaten & Dokumentation
└── references/
├── summary.md # Zweck, Format und Statistiken
├── project-structure.md # Verzeichnisbaum mit Zeilenzahlen
├── files.md # Alle Dateiinhalte (grep-freundlich)
└── tech-stack.md # Sprachen, Frameworks, Abhängigkeiten
```

### Dateibeschreibungen

#### SKILL.md

Die Haupt-Skills-Datei enthält:
- Skills-Name, Beschreibung und Projektinformationen
- Dateianzahl, Zeilenanzahl und Token-Anzahl
- Übersicht zur Verwendung der Skills
- Dateispeicherorte und Formaterklärung
- Häufige Anwendungsfälle und Tipps

#### references/summary.md

Enthält:
- **Zweck**: Erklärt, dass dies eine Referenz-Codebase für KI-Nutzung ist
- **Dateistruktur**: Dokumentiert den Inhalt jeder Referenzdatei
- **Nutzungsrichtlinien**: Wie die Skills effektiv verwendet werden
- **Statistiken**: Aufschlüsselung nach Dateityp, Sprache und größten Dateien

#### references/project-structure.md

Verzeichnisbaum mit Zeilenzahlen pro Datei zur einfachen Dateifindung:

```text
src/
index.ts (42 lines)
utils/
helpers.ts (128 lines)
math.ts (87 lines)
```

#### references/files.md

Alle Dateiinhalte mit Syntax-Highlighting-Headern, optimiert für grep-freundliche Suche:

````markdown
## File: src/index.ts
```typescript
import { sum } from './utils/helpers';

export function main() {
console.log(sum(1, 2));
}
```
````

#### references/tech-stack.md

Automatisch erkannter Tech-Stack aus Abhängigkeitsdateien:
- **Sprachen**: TypeScript, JavaScript, Python, usw.
- **Frameworks**: React, Next.js, Express, Django, usw.
- **Laufzeitversionen**: Node.js, Python, Go, usw.
- **Paketmanager**: npm, pnpm, poetry, usw.
- **Abhängigkeiten**: Alle direkten und Entwicklungs-Abhängigkeiten
- **Konfigurationsdateien**: Alle erkannten Konfigurationsdateien

Erkannt aus Dateien wie: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, usw.

## Automatisch generierte Skills-Namen

Wenn kein Name angegeben wird, generiert Repomix automatisch einen mit diesem Muster:

```bash
repomix src/ --skill-generate # → repomix-reference-src
repomix --remote user/repo --skill-generate # → repomix-reference-repo
repomix --skill-generate CustomName # → custom-name (normalisiert zu kebab-case)
```

Skills-Namen werden:
- In kebab-case konvertiert (Kleinbuchstaben, durch Bindestriche getrennt)
- Auf maximal 64 Zeichen begrenzt
- Gegen Pfad-Traversierung geschützt

## Integration mit Repomix-Optionen

Die Skills-Generierung respektiert alle Standard-Repomix-Optionen:

```bash
# Skills mit Dateifilterung generieren
repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts"

# Skills mit Komprimierung generieren
repomix --skill-generate --compress

# Skills aus entferntem Repository generieren
repomix --remote yamadashy/repomix --skill-generate

# Skills mit spezifischen Ausgabeformat-Optionen generieren
repomix --skill-generate --remove-comments --remove-empty-lines
```

### Nur-Dokumentations-Skills

Mit `--include` können Sie Skills generieren, die nur die Dokumentation aus einem GitHub-Repository enthalten. Dies ist nützlich, wenn Sie Claude auf spezifische Bibliotheks- oder Framework-Dokumentation verweisen möchten, während Sie an Ihrem Code arbeiten:

```bash
# Claude Code Action Dokumentation
repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate

# Vite Dokumentation
repomix --remote https://github.com/vitejs/vite --include docs --skill-generate

# React Dokumentation
repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate
```

## Einschränkungen

Die Option `--skill-generate` kann nicht verwendet werden mit:
- `--stdout` - Skills-Ausgabe erfordert Schreiben ins Dateisystem
- `--copy` - Skills-Ausgabe ist ein Verzeichnis, nicht in die Zwischenablage kopierbar

## Generierte Skills verwenden

Sobald generiert, können Sie die Skills mit Claude verwenden:

1. **Claude Code**: Die Skills sind automatisch verfügbar, wenn sie unter `~/.claude/skills/` oder `.claude/skills/` gespeichert sind
2. **Claude Web**: Laden Sie das Skills-Verzeichnis zur Codebase-Analyse zu Claude hoch
3. **Team-Teilen**: Committen Sie `.claude/skills/` in Ihr Repository für teamweiten Zugriff

## Beispiel-Workflow

### Persönliche Referenzbibliothek erstellen

```bash
# Ein interessantes Open-Source-Projekt klonen und analysieren
repomix --remote facebook/react --skill-generate react-reference

# Die Skills werden unter ~/.claude/skills/react-reference/ gespeichert
# Jetzt können Sie Reacts Codebase in jeder Claude-Konversation referenzieren
```

### Team-Projekt-Dokumentation

```bash
# In Ihrem Projektverzeichnis
cd my-project

# Skills für Ihr Team generieren
repomix --skill-generate

# Wählen Sie "Project Skills" wenn aufgefordert
# Die Skills werden unter .claude/skills/repomix-reference-my-project/ gespeichert

# Committen und mit Ihrem Team teilen
git add .claude/skills/
git commit -m "Add codebase reference Skills"
```

## Verwandte Ressourcen

- [Claude Code Plugins](/de/guide/claude-code-plugins) - Erfahren Sie mehr über Repomix-Plugins für Claude Code
- [MCP-Server](/de/guide/mcp-server) - Alternative Integrationsmethode
- [Code-Komprimierung](/de/guide/code-compress) - Token-Anzahl durch Komprimierung reduzieren
- [Konfiguration](/de/guide/configuration) - Repomix-Verhalten anpassen
Loading
Loading