diff --git a/README.md b/README.md index 56c176b97..4a72ad3e0 100644 --- a/README.md +++ b/README.md @@ -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//` directory (name auto-generated if omitted) + #### Examples ```bash @@ -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.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 +``` + +#### 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. diff --git a/website/client/.vitepress/config/configDe.ts b/website/client/.vitepress/config/configDe.ts index fe9a9de54..cf2562e31 100644 --- a/website/client/.vitepress/config/configDe.ts +++ b/website/client/.vitepress/config/configDe.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configEnUs.ts b/website/client/.vitepress/config/configEnUs.ts index 4f2960671..20624810d 100644 --- a/website/client/.vitepress/config/configEnUs.ts +++ b/website/client/.vitepress/config/configEnUs.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configEs.ts b/website/client/.vitepress/config/configEs.ts index 92498f0c4..d2e6fa0dc 100644 --- a/website/client/.vitepress/config/configEs.ts +++ b/website/client/.vitepress/config/configEs.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configFr.ts b/website/client/.vitepress/config/configFr.ts index 3c05f2866..c892afe68 100644 --- a/website/client/.vitepress/config/configFr.ts +++ b/website/client/.vitepress/config/configFr.ts @@ -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', diff --git a/website/client/.vitepress/config/configHi.ts b/website/client/.vitepress/config/configHi.ts index 594b354aa..07bdcc5b0 100644 --- a/website/client/.vitepress/config/configHi.ts +++ b/website/client/.vitepress/config/configHi.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configId.ts b/website/client/.vitepress/config/configId.ts index bdd035f27..384ff9573 100644 --- a/website/client/.vitepress/config/configId.ts +++ b/website/client/.vitepress/config/configId.ts @@ -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', diff --git a/website/client/.vitepress/config/configJa.ts b/website/client/.vitepress/config/configJa.ts index 0ffb4c74b..dc5519443 100644 --- a/website/client/.vitepress/config/configJa.ts +++ b/website/client/.vitepress/config/configJa.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configKo.ts b/website/client/.vitepress/config/configKo.ts index eb4e3997b..f3d00837e 100644 --- a/website/client/.vitepress/config/configKo.ts +++ b/website/client/.vitepress/config/configKo.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configPtBr.ts b/website/client/.vitepress/config/configPtBr.ts index bfb2c34dc..ff9045cfb 100644 --- a/website/client/.vitepress/config/configPtBr.ts +++ b/website/client/.vitepress/config/configPtBr.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configVi.ts b/website/client/.vitepress/config/configVi.ts index b479ba3ba..8d629468a 100644 --- a/website/client/.vitepress/config/configVi.ts +++ b/website/client/.vitepress/config/configVi.ts @@ -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', diff --git a/website/client/.vitepress/config/configZhCn.ts b/website/client/.vitepress/config/configZhCn.ts index 4d1b1d8c7..8057534f9 100644 --- a/website/client/.vitepress/config/configZhCn.ts +++ b/website/client/.vitepress/config/configZhCn.ts @@ -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' }, diff --git a/website/client/.vitepress/config/configZhTw.ts b/website/client/.vitepress/config/configZhTw.ts index a386c5a1f..027d4177f 100644 --- a/website/client/.vitepress/config/configZhTw.ts +++ b/website/client/.vitepress/config/configZhTw.ts @@ -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' }, diff --git a/website/client/src/de/guide/agent-skills-generation.md b/website/client/src/de/guide/agent-skills-generation.md new file mode 100644 index 000000000..8a0272def --- /dev/null +++ b/website/client/src/de/guide/agent-skills-generation.md @@ -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.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 diff --git a/website/client/src/en/guide/agent-skills-generation.md b/website/client/src/en/guide/agent-skills-generation.md new file mode 100644 index 000000000..81d5e20dc --- /dev/null +++ b/website/client/src/en/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# 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. By generating Skills from open source projects, you can easily ask Claude to reference specific patterns or implementations while working on your own code. + +Instead of generating a single packed file, Skills generation creates a structured directory with multiple reference files optimized for AI comprehension and grep-friendly searching. + +> [!NOTE] +> This is an experimental feature. The output format and options may change in future releases based on user feedback. + +## Basic Usage + +Generate Skills from your local directory: + +```bash +# Generate Skills from current directory +repomix --skill-generate + +# Generate with custom Skills name +repomix --skill-generate my-project-reference + +# Generate from specific directory +repomix path/to/directory --skill-generate + +# Generate from remote repository +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Skills Location Selection + +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 + +If the Skills directory already exists, you'll be prompted to confirm overwriting it. + +> [!TIP] +> When generating Project Skills, consider adding them to `.gitignore` to avoid committing large files: +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## Generated Structure + +The Skills are generated with the following structure: + +```text +.claude/skills// +├── 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 +``` + +### File Descriptions + +#### SKILL.md + +The main Skills file containing: +- Skills name, description, and project info +- File count, line count, and token count +- Overview of how to use the Skills +- File locations and format explanation +- Common use cases and tips + +#### references/summary.md + +Contains: +- **Purpose**: Explains this is a reference codebase for AI consumption +- **File Structure**: Documents what's in each reference file +- **Usage Guidelines**: How to use the Skills effectively +- **Statistics**: Breakdown by file type, language, and largest files + +#### references/project-structure.md + +Directory tree with line counts per file for easy file discovery: + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +All file contents with syntax highlighting headers, optimized for grep-friendly searching: + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +Auto-detected tech stack from dependency files: +- **Languages**: TypeScript, JavaScript, Python, etc. +- **Frameworks**: React, Next.js, Express, Django, etc. +- **Runtime Versions**: Node.js, Python, Go, etc. +- **Package Manager**: npm, pnpm, poetry, etc. +- **Dependencies**: All direct and dev dependencies +- **Config Files**: All detected configuration files + +Detected from files like: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, etc. + +## Auto-Generated Skills Names + +If no name is provided, Repomix auto-generates one using this pattern: + +```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) +``` + +Skills names are: +- Converted to kebab-case (lowercase, hyphen-separated) +- Limited to 64 characters maximum +- Protected against path traversal + +## Integration with Repomix Options + +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 + +# Generate Skills with specific output format options +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### Documentation-Only Skills + +Using `--include`, you can generate Skills containing only the documentation from a GitHub repository. This is useful when you want Claude to reference specific library or framework documentation while working on your code: + +```bash +# Claude Code Action documentation +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Vite documentation +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# React documentation +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## Limitations + +The `--skill-generate` option cannot be used with: +- `--stdout` - Skills output requires writing to filesystem +- `--copy` - Skills output is a directory, not copyable to clipboard + +## Using Generated Skills + +Once generated, you can use the Skills with Claude: + +1. **Claude Code**: The Skills are automatically available if saved to `~/.claude/skills/` or `.claude/skills/` +2. **Claude Web**: Upload the Skills directory to Claude for codebase analysis +3. **Team Sharing**: Commit `.claude/skills/` to your repository for team-wide access + +## Example Workflow + +### Creating a Personal Reference Library + +```bash +# Clone and analyze an interesting open source project +repomix --remote facebook/react --skill-generate react-reference + +# The Skills are saved to ~/.claude/skills/react-reference/ +# Now you can reference React's codebase in any Claude conversation +``` + +### Team Project Documentation + +```bash +# In your project directory +cd my-project + +# Generate Skills for your team +repomix --skill-generate + +# Choose "Project Skills" when prompted +# The Skills are saved to .claude/skills/repomix-reference-my-project/ + +# Commit and share with your team +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## Related Resources + +- [Claude Code Plugins](/guide/claude-code-plugins) - Learn about Repomix plugins for Claude Code +- [MCP Server](/guide/mcp-server) - Alternative integration method +- [Code Compression](/guide/code-compress) - Reduce token count with compression +- [Configuration](/guide/configuration) - Customize Repomix behavior diff --git a/website/client/src/es/guide/agent-skills-generation.md b/website/client/src/es/guide/agent-skills-generation.md new file mode 100644 index 000000000..1a11ebf76 --- /dev/null +++ b/website/client/src/es/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Generación de Agent Skills + +Repomix puede generar salida en formato [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills), creando un directorio estructurado de Skills que puede usarse como referencia de código reutilizable para asistentes de IA. + +Esta función es particularmente poderosa cuando desea referenciar implementaciones de repositorios remotos. Al generar Skills desde proyectos de código abierto, puede fácilmente pedir a Claude que referencie patrones o implementaciones específicas mientras trabaja en su propio código. + +En lugar de generar un único archivo empaquetado, la generación de Skills crea un directorio estructurado con múltiples archivos de referencia optimizados para la comprensión de IA y búsqueda compatible con grep. + +> [!NOTE] +> Esta es una función experimental. El formato de salida y las opciones pueden cambiar en futuras versiones basándose en los comentarios de los usuarios. + +## Uso Básico + +Generar Skills desde su directorio local: + +```bash +# Generar Skills desde el directorio actual +repomix --skill-generate + +# Generar con nombre personalizado de Skills +repomix --skill-generate my-project-reference + +# Generar desde un directorio específico +repomix path/to/directory --skill-generate + +# Generar desde repositorio remoto +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Selección de Ubicación de Skills + +Cuando ejecuta el comando, Repomix le solicita elegir dónde guardar los Skills: + +1. **Personal Skills** (`~/.claude/skills/`) - Disponible en todos los proyectos de su máquina +2. **Project Skills** (`.claude/skills/`) - Compartido con su equipo vía git + +Si el directorio de Skills ya existe, se le pedirá confirmar la sobrescritura. + +> [!TIP] +> Al generar Project Skills, considere agregarlos a `.gitignore` para evitar hacer commit de archivos grandes: +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## Estructura Generada + +Los Skills se generan con la siguiente estructura: + +```text +.claude/skills// +├── SKILL.md # Metadatos principales y documentación de Skills +└── references/ + ├── summary.md # Propósito, formato y estadísticas + ├── project-structure.md # Árbol de directorios con conteo de líneas + ├── files.md # Todo el contenido de archivos (compatible con grep) + └── tech-stack.md # Lenguajes, frameworks, dependencias +``` + +### Descripciones de Archivos + +#### SKILL.md + +El archivo principal de Skills contiene: +- Nombre del Skills, descripción e información del proyecto +- Conteo de archivos, líneas y tokens +- Resumen de cómo usar los Skills +- Ubicaciones de archivos y explicación del formato +- Casos de uso comunes y consejos + +#### references/summary.md + +Contiene: +- **Propósito**: Explica que es un código base de referencia para consumo de IA +- **Estructura de Archivos**: Documenta el contenido de cada archivo de referencia +- **Guías de Uso**: Cómo usar los Skills efectivamente +- **Estadísticas**: Desglose por tipo de archivo, lenguaje y archivos más grandes + +#### references/project-structure.md + +Árbol de directorios con conteo de líneas por archivo para fácil descubrimiento: + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +Todo el contenido de archivos con encabezados de resaltado de sintaxis, optimizado para búsqueda compatible con grep: + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +Stack tecnológico autodetectado desde archivos de dependencias: +- **Lenguajes**: TypeScript, JavaScript, Python, etc. +- **Frameworks**: React, Next.js, Express, Django, etc. +- **Versiones de Runtime**: Node.js, Python, Go, etc. +- **Gestor de Paquetes**: npm, pnpm, poetry, etc. +- **Dependencias**: Todas las dependencias directas y de desarrollo +- **Archivos de Configuración**: Todos los archivos de configuración detectados + +Detectado desde archivos como: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, etc. + +## Nombres de Skills Autogenerados + +Si no se proporciona nombre, Repomix autogenera uno usando este patrón: + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name (normalizado a kebab-case) +``` + +Los nombres de Skills son: +- Convertidos a kebab-case (minúsculas, separados por guiones) +- Limitados a máximo 64 caracteres +- Protegidos contra path traversal + +## Integración con Opciones de Repomix + +La generación de Skills respeta todas las opciones estándar de Repomix: + +```bash +# Generar Skills con filtrado de archivos +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# Generar Skills con compresión +repomix --skill-generate --compress + +# Generar Skills desde repositorio remoto +repomix --remote yamadashy/repomix --skill-generate + +# Generar Skills con opciones específicas de formato de salida +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### Skills Solo de Documentación + +Usando `--include`, puede generar Skills que contengan solo la documentación de un repositorio de GitHub. Esto es útil cuando desea que Claude referencie documentación específica de biblioteca o framework mientras trabaja en su código: + +```bash +# Documentación de Claude Code Action +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Documentación de Vite +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# Documentación de React +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## Limitaciones + +La opción `--skill-generate` no puede usarse con: +- `--stdout` - La salida de Skills requiere escribir en el sistema de archivos +- `--copy` - La salida de Skills es un directorio, no se puede copiar al portapapeles + +## Usando Skills Generados + +Una vez generados, puede usar los Skills con Claude: + +1. **Claude Code**: Los Skills están disponibles automáticamente si se guardan en `~/.claude/skills/` o `.claude/skills/` +2. **Claude Web**: Suba el directorio de Skills a Claude para análisis de código base +3. **Compartir con Equipo**: Haga commit de `.claude/skills/` a su repositorio para acceso de todo el equipo + +## Flujo de Trabajo de Ejemplo + +### Crear una Biblioteca de Referencia Personal + +```bash +# Clonar y analizar un proyecto de código abierto interesante +repomix --remote facebook/react --skill-generate react-reference + +# Los Skills se guardan en ~/.claude/skills/react-reference/ +# Ahora puede referenciar el código base de React en cualquier conversación con Claude +``` + +### Documentación de Proyecto de Equipo + +```bash +# En su directorio de proyecto +cd my-project + +# Generar Skills para su equipo +repomix --skill-generate + +# Elija "Project Skills" cuando se le solicite +# Los Skills se guardan en .claude/skills/repomix-reference-my-project/ + +# Haga commit y comparta con su equipo +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## Recursos Relacionados + +- [Plugins de Claude Code](/es/guide/claude-code-plugins) - Aprenda sobre plugins de Repomix para Claude Code +- [Servidor MCP](/es/guide/mcp-server) - Método de integración alternativo +- [Compresión de Código](/es/guide/code-compress) - Reducir conteo de tokens con compresión +- [Configuración](/es/guide/configuration) - Personalizar comportamiento de Repomix diff --git a/website/client/src/fr/guide/agent-skills-generation.md b/website/client/src/fr/guide/agent-skills-generation.md new file mode 100644 index 000000000..8ae2a0f63 --- /dev/null +++ b/website/client/src/fr/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Génération d'Agent Skills + +Repomix peut générer une sortie au format [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills), créant un répertoire structuré de Skills qui peut être utilisé comme référence de base de code réutilisable pour les assistants IA. + +Cette fonctionnalité est particulièrement puissante lorsque vous souhaitez référencer des implémentations de dépôts distants. En générant des Skills à partir de projets open source, vous pouvez facilement demander à Claude de référencer des modèles ou implémentations spécifiques tout en travaillant sur votre propre code. + +Au lieu de générer un seul fichier empaqueté, la génération de Skills crée un répertoire structuré avec plusieurs fichiers de référence optimisés pour la compréhension de l'IA et la recherche compatible avec grep. + +> [!NOTE] +> Il s'agit d'une fonctionnalité expérimentale. Le format de sortie et les options peuvent changer dans les futures versions en fonction des retours utilisateurs. + +## Utilisation de Base + +Générer des Skills depuis votre répertoire local : + +```bash +# Générer des Skills depuis le répertoire actuel +repomix --skill-generate + +# Générer avec un nom de Skills personnalisé +repomix --skill-generate my-project-reference + +# Générer depuis un répertoire spécifique +repomix path/to/directory --skill-generate + +# Générer depuis un dépôt distant +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Sélection de l'Emplacement des Skills + +Lorsque vous exécutez la commande, Repomix vous demande de choisir où sauvegarder les Skills : + +1. **Personal Skills** (`~/.claude/skills/`) - Disponible pour tous les projets sur votre machine +2. **Project Skills** (`.claude/skills/`) - Partagé avec votre équipe via git + +Si le répertoire Skills existe déjà, on vous demandera de confirmer l'écrasement. + +> [!TIP] +> Lors de la génération de Project Skills, envisagez de les ajouter à `.gitignore` pour éviter de commiter de gros fichiers : +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## Structure Générée + +Les Skills sont générés avec la structure suivante : + +```text +.claude/skills// +├── SKILL.md # Métadonnées principales et documentation des Skills +└── references/ + ├── summary.md # But, format et statistiques + ├── project-structure.md # Arborescence avec nombre de lignes + ├── files.md # Tout le contenu des fichiers (compatible grep) + └── tech-stack.md # Langages, frameworks, dépendances +``` + +### Descriptions des Fichiers + +#### SKILL.md + +Le fichier principal des Skills contient : +- Nom des Skills, description et informations du projet +- Nombre de fichiers, de lignes et de tokens +- Aperçu de l'utilisation des Skills +- Emplacements des fichiers et explication du format +- Cas d'utilisation courants et conseils + +#### references/summary.md + +Contient : +- **But** : Explique qu'il s'agit d'une base de code de référence pour utilisation par l'IA +- **Structure des Fichiers** : Documente le contenu de chaque fichier de référence +- **Directives d'Utilisation** : Comment utiliser efficacement les Skills +- **Statistiques** : Répartition par type de fichier, langage et plus gros fichiers + +#### references/project-structure.md + +Arborescence avec nombre de lignes par fichier pour une découverte facile : + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +Tout le contenu des fichiers avec en-têtes de coloration syntaxique, optimisé pour la recherche compatible grep : + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +Stack technologique auto-détecté depuis les fichiers de dépendances : +- **Langages** : TypeScript, JavaScript, Python, etc. +- **Frameworks** : React, Next.js, Express, Django, etc. +- **Versions Runtime** : Node.js, Python, Go, etc. +- **Gestionnaire de Paquets** : npm, pnpm, poetry, etc. +- **Dépendances** : Toutes les dépendances directes et de développement +- **Fichiers de Configuration** : Tous les fichiers de configuration détectés + +Détecté depuis des fichiers comme : `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, etc. + +## Noms de Skills Auto-Générés + +Si aucun nom n'est fourni, Repomix en génère automatiquement un avec ce modèle : + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name (normalisé en kebab-case) +``` + +Les noms de Skills sont : +- Convertis en kebab-case (minuscules, séparés par des tirets) +- Limités à 64 caractères maximum +- Protégés contre le path traversal + +## Intégration avec les Options Repomix + +La génération de Skills respecte toutes les options standard de Repomix : + +```bash +# Générer des Skills avec filtrage de fichiers +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# Générer des Skills avec compression +repomix --skill-generate --compress + +# Générer des Skills depuis un dépôt distant +repomix --remote yamadashy/repomix --skill-generate + +# Générer des Skills avec des options de format de sortie spécifiques +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### Skills Documentation Uniquement + +En utilisant `--include`, vous pouvez générer des Skills contenant uniquement la documentation d'un dépôt GitHub. C'est utile quand vous voulez que Claude référence une documentation spécifique de bibliothèque ou framework pendant que vous travaillez sur votre code : + +```bash +# Documentation Claude Code Action +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Documentation Vite +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# Documentation React +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## Limitations + +L'option `--skill-generate` ne peut pas être utilisée avec : +- `--stdout` - La sortie Skills nécessite l'écriture sur le système de fichiers +- `--copy` - La sortie Skills est un répertoire, non copiable dans le presse-papiers + +## Utilisation des Skills Générés + +Une fois générés, vous pouvez utiliser les Skills avec Claude : + +1. **Claude Code** : Les Skills sont automatiquement disponibles s'ils sont sauvegardés dans `~/.claude/skills/` ou `.claude/skills/` +2. **Claude Web** : Téléchargez le répertoire Skills vers Claude pour l'analyse de base de code +3. **Partage d'Équipe** : Commitez `.claude/skills/` dans votre dépôt pour un accès de toute l'équipe + +## Exemple de Workflow + +### Créer une Bibliothèque de Référence Personnelle + +```bash +# Cloner et analyser un projet open source intéressant +repomix --remote facebook/react --skill-generate react-reference + +# Les Skills sont sauvegardés dans ~/.claude/skills/react-reference/ +# Maintenant vous pouvez référencer la base de code de React dans n'importe quelle conversation Claude +``` + +### Documentation de Projet d'Équipe + +```bash +# Dans votre répertoire de projet +cd my-project + +# Générer des Skills pour votre équipe +repomix --skill-generate + +# Choisissez "Project Skills" quand demandé +# Les Skills sont sauvegardés dans .claude/skills/repomix-reference-my-project/ + +# Commitez et partagez avec votre équipe +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## Ressources Connexes + +- [Plugins Claude Code](/fr/guide/claude-code-plugins) - En savoir plus sur les plugins Repomix pour Claude Code +- [Serveur MCP](/fr/guide/mcp-server) - Méthode d'intégration alternative +- [Compression de Code](/fr/guide/code-compress) - Réduire le nombre de tokens avec la compression +- [Configuration](/fr/guide/configuration) - Personnaliser le comportement de Repomix diff --git a/website/client/src/hi/guide/agent-skills-generation.md b/website/client/src/hi/guide/agent-skills-generation.md new file mode 100644 index 000000000..a4ead1bb0 --- /dev/null +++ b/website/client/src/hi/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Agent Skills जनरेशन + +Repomix [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills) फॉर्मेट में आउटपुट जनरेट कर सकता है, एक स्ट्रक्चर्ड Skills डायरेक्टरी बनाता है जिसे AI असिस्टेंट के लिए पुन: प्रयोज्य कोडबेस रेफरेंस के रूप में उपयोग किया जा सकता है। + +यह फीचर विशेष रूप से शक्तिशाली है जब आप रिमोट रिपॉजिटरी से इम्प्लीमेंटेशन रेफर करना चाहते हैं। ओपन सोर्स प्रोजेक्ट्स से Skills जनरेट करके, आप आसानी से Claude से अपने कोड पर काम करते समय विशिष्ट पैटर्न या इम्प्लीमेंटेशन रेफर करने के लिए कह सकते हैं। + +एक सिंगल पैक्ड फाइल जनरेट करने के बजाय, Skills जनरेशन AI समझ और grep-फ्रेंडली सर्चिंग के लिए ऑप्टिमाइज़ किए गए मल्टीपल रेफरेंस फाइलों के साथ एक स्ट्रक्चर्ड डायरेक्टरी बनाता है। + +> [!NOTE] +> यह एक प्रयोगात्मक फीचर है। आउटपुट फॉर्मेट और ऑप्शन भविष्य के रिलीज में यूजर फीडबैक के आधार पर बदल सकते हैं। + +## बेसिक उपयोग + +अपनी लोकल डायरेक्टरी से Skills जनरेट करें: + +```bash +# करंट डायरेक्टरी से Skills जनरेट करें +repomix --skill-generate + +# कस्टम Skills नाम के साथ जनरेट करें +repomix --skill-generate my-project-reference + +# विशिष्ट डायरेक्टरी से जनरेट करें +repomix path/to/directory --skill-generate + +# रिमोट रिपॉजिटरी से जनरेट करें +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Skills लोकेशन सिलेक्शन + +जब आप कमांड चलाते हैं, Repomix आपको Skills को कहाँ सेव करना है चुनने के लिए कहता है: + +1. **Personal Skills** (`~/.claude/skills/`) - आपकी मशीन पर सभी प्रोजेक्ट्स में उपलब्ध +2. **Project Skills** (`.claude/skills/`) - git के माध्यम से आपकी टीम के साथ शेयर + +अगर Skills डायरेक्टरी पहले से मौजूद है, आपसे ओवरराइट करने की पुष्टि मांगी जाएगी। + +> [!TIP] +> Project Skills जनरेट करते समय, बड़ी फाइलों को कमिट करने से बचने के लिए उन्हें `.gitignore` में जोड़ने पर विचार करें: +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## जनरेटेड स्ट्रक्चर + +Skills निम्नलिखित स्ट्रक्चर के साथ जनरेट होते हैं: + +```text +.claude/skills// +├── SKILL.md # मेन Skills मेटाडेटा और डॉक्यूमेंटेशन +└── references/ + ├── summary.md # पर्पस, फॉर्मेट, और स्टैटिस्टिक्स + ├── project-structure.md # लाइन काउंट के साथ डायरेक्टरी ट्री + ├── files.md # सभी फाइल कंटेंट (grep-फ्रेंडली) + └── tech-stack.md # लैंग्वेजेस, फ्रेमवर्क्स, डिपेंडेंसीज +``` + +### फाइल डिस्क्रिप्शन + +#### SKILL.md + +मेन Skills फाइल में शामिल है: +- Skills नाम, डिस्क्रिप्शन, और प्रोजेक्ट इन्फो +- फाइल काउंट, लाइन काउंट, और टोकन काउंट +- Skills का उपयोग कैसे करें का ओवरव्यू +- फाइल लोकेशन और फॉर्मेट एक्सप्लेनेशन +- कॉमन यूज केसेस और टिप्स + +#### references/summary.md + +शामिल है: +- **पर्पस**: बताता है कि यह AI कंजम्पशन के लिए एक रेफरेंस कोडबेस है +- **फाइल स्ट्रक्चर**: प्रत्येक रेफरेंस फाइल में क्या है डॉक्यूमेंट करता है +- **उपयोग गाइडलाइंस**: Skills को प्रभावी ढंग से कैसे उपयोग करें +- **स्टैटिस्टिक्स**: फाइल टाइप, लैंग्वेज, और सबसे बड़ी फाइलों के अनुसार ब्रेकडाउन + +#### references/project-structure.md + +आसान फाइल डिस्कवरी के लिए प्रति फाइल लाइन काउंट के साथ डायरेक्टरी ट्री: + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +सभी फाइल कंटेंट सिंटैक्स हाइलाइटिंग हेडर के साथ, grep-फ्रेंडली सर्चिंग के लिए ऑप्टिमाइज़: + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +डिपेंडेंसी फाइलों से ऑटो-डिटेक्टेड टेक स्टैक: +- **लैंग्वेजेस**: TypeScript, JavaScript, Python, आदि +- **फ्रेमवर्क्स**: React, Next.js, Express, Django, आदि +- **रनटाइम वर्जन्स**: Node.js, Python, Go, आदि +- **पैकेज मैनेजर**: npm, pnpm, poetry, आदि +- **डिपेंडेंसीज**: सभी डायरेक्ट और dev डिपेंडेंसीज +- **कॉन्फिग फाइल्स**: सभी डिटेक्टेड कॉन्फिगरेशन फाइलें + +इन फाइलों से डिटेक्ट: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, आदि। + +## ऑटो-जनरेटेड Skills नाम + +अगर कोई नाम नहीं दिया जाता, Repomix इस पैटर्न का उपयोग करके ऑटो-जनरेट करता है: + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name (kebab-case में नॉर्मलाइज़) +``` + +Skills नाम: +- kebab-case (लोअरकेस, हाइफन-सेपरेटेड) में कन्वर्ट +- अधिकतम 64 कैरेक्टर तक सीमित +- पाथ ट्रैवर्सल से प्रोटेक्टेड + +## Repomix ऑप्शंस के साथ इंटीग्रेशन + +Skills जनरेशन सभी स्टैंडर्ड Repomix ऑप्शंस का सम्मान करता है: + +```bash +# फाइल फिल्टरिंग के साथ Skills जनरेट करें +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# कम्प्रेशन के साथ Skills जनरेट करें +repomix --skill-generate --compress + +# रिमोट रिपॉजिटरी से Skills जनरेट करें +repomix --remote yamadashy/repomix --skill-generate + +# स्पेसिफिक आउटपुट फॉर्मेट ऑप्शंस के साथ Skills जनरेट करें +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### डॉक्यूमेंटेशन-ओनली Skills + +`--include` का उपयोग करके, आप GitHub रिपॉजिटरी से केवल डॉक्यूमेंटेशन वाले Skills जनरेट कर सकते हैं। यह तब उपयोगी है जब आप चाहते हैं कि Claude आपके कोड पर काम करते समय स्पेसिफिक लाइब्रेरी या फ्रेमवर्क डॉक्यूमेंटेशन रेफर करे: + +```bash +# Claude Code Action डॉक्यूमेंटेशन +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Vite डॉक्यूमेंटेशन +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# React डॉक्यूमेंटेशन +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## सीमाएं + +`--skill-generate` ऑप्शन इनके साथ उपयोग नहीं किया जा सकता: +- `--stdout` - Skills आउटपुट को फाइलसिस्टम में लिखना आवश्यक है +- `--copy` - Skills आउटपुट एक डायरेक्टरी है, क्लिपबोर्ड में कॉपी नहीं किया जा सकता + +## जनरेटेड Skills का उपयोग + +जनरेट होने के बाद, आप Claude के साथ Skills का उपयोग कर सकते हैं: + +1. **Claude Code**: अगर `~/.claude/skills/` या `.claude/skills/` में सेव किया गया है तो Skills ऑटोमैटिकली उपलब्ध हैं +2. **Claude Web**: कोडबेस एनालिसिस के लिए Skills डायरेक्टरी को Claude पर अपलोड करें +3. **टीम शेयरिंग**: टीम-वाइड एक्सेस के लिए `.claude/skills/` को अपने रिपॉजिटरी में कमिट करें + +## उदाहरण वर्कफ्लो + +### पर्सनल रेफरेंस लाइब्रेरी बनाना + +```bash +# एक इंटरेस्टिंग ओपन सोर्स प्रोजेक्ट क्लोन और एनालाइज़ करें +repomix --remote facebook/react --skill-generate react-reference + +# Skills ~/.claude/skills/react-reference/ में सेव होते हैं +# अब आप किसी भी Claude कन्वर्सेशन में React का कोडबेस रेफर कर सकते हैं +``` + +### टीम प्रोजेक्ट डॉक्यूमेंटेशन + +```bash +# अपनी प्रोजेक्ट डायरेक्टरी में +cd my-project + +# अपनी टीम के लिए Skills जनरेट करें +repomix --skill-generate + +# प्रॉम्प्ट होने पर "Project Skills" चुनें +# Skills .claude/skills/repomix-reference-my-project/ में सेव होते हैं + +# कमिट करें और अपनी टीम के साथ शेयर करें +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## संबंधित रिसोर्सेज + +- [Claude Code Plugins](/hi/guide/claude-code-plugins) - Claude Code के लिए Repomix प्लगइन्स के बारे में जानें +- [MCP Server](/hi/guide/mcp-server) - वैकल्पिक इंटीग्रेशन मेथड +- [कोड कम्प्रेशन](/hi/guide/code-compress) - कम्प्रेशन के साथ टोकन काउंट कम करें +- [कॉन्फिगरेशन](/hi/guide/configuration) - Repomix बिहेवियर कस्टमाइज़ करें diff --git a/website/client/src/id/guide/agent-skills-generation.md b/website/client/src/id/guide/agent-skills-generation.md new file mode 100644 index 000000000..c6498c66d --- /dev/null +++ b/website/client/src/id/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Pembuatan Agent Skills + +Repomix dapat menghasilkan output dalam format [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills), membuat direktori Skills terstruktur yang dapat digunakan sebagai referensi codebase yang dapat digunakan kembali untuk asisten AI. + +Fitur ini sangat powerful ketika Anda ingin mereferensikan implementasi dari repository jarak jauh. Dengan menghasilkan Skills dari proyek open source, Anda dapat dengan mudah meminta Claude untuk mereferensikan pola atau implementasi tertentu saat mengerjakan kode Anda sendiri. + +Alih-alih menghasilkan satu file yang dikemas, pembuatan Skills membuat direktori terstruktur dengan beberapa file referensi yang dioptimalkan untuk pemahaman AI dan pencarian yang kompatibel dengan grep. + +> [!NOTE] +> Ini adalah fitur eksperimental. Format output dan opsi dapat berubah di rilis mendatang berdasarkan umpan balik pengguna. + +## Penggunaan Dasar + +Hasilkan Skills dari direktori lokal Anda: + +```bash +# Hasilkan Skills dari direktori saat ini +repomix --skill-generate + +# Hasilkan dengan nama Skills kustom +repomix --skill-generate my-project-reference + +# Hasilkan dari direktori tertentu +repomix path/to/directory --skill-generate + +# Hasilkan dari repository jarak jauh +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Pemilihan Lokasi Skills + +Saat Anda menjalankan perintah, Repomix meminta Anda untuk memilih tempat menyimpan Skills: + +1. **Personal Skills** (`~/.claude/skills/`) - Tersedia di semua proyek di mesin Anda +2. **Project Skills** (`.claude/skills/`) - Dibagikan dengan tim Anda via git + +Jika direktori Skills sudah ada, Anda akan diminta untuk mengkonfirmasi penimpaan. + +> [!TIP] +> Saat menghasilkan Project Skills, pertimbangkan untuk menambahkannya ke `.gitignore` untuk menghindari commit file besar: +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## Struktur yang Dihasilkan + +Skills dihasilkan dengan struktur berikut: + +```text +.claude/skills// +├── SKILL.md # Metadata utama Skills & dokumentasi +└── references/ + ├── summary.md # Tujuan, format, dan statistik + ├── project-structure.md # Pohon direktori dengan jumlah baris + ├── files.md # Semua konten file (kompatibel grep) + └── tech-stack.md # Bahasa, framework, dependensi +``` + +### Deskripsi File + +#### SKILL.md + +File Skills utama berisi: +- Nama Skills, deskripsi, dan info proyek +- Jumlah file, jumlah baris, dan jumlah token +- Gambaran cara menggunakan Skills +- Lokasi file dan penjelasan format +- Kasus penggunaan umum dan tips + +#### references/summary.md + +Berisi: +- **Tujuan**: Menjelaskan ini adalah codebase referensi untuk konsumsi AI +- **Struktur File**: Mendokumentasikan isi setiap file referensi +- **Panduan Penggunaan**: Cara menggunakan Skills secara efektif +- **Statistik**: Rincian berdasarkan tipe file, bahasa, dan file terbesar + +#### references/project-structure.md + +Pohon direktori dengan jumlah baris per file untuk penemuan file yang mudah: + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +Semua konten file dengan header syntax highlighting, dioptimalkan untuk pencarian kompatibel grep: + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +Tech stack yang terdeteksi otomatis dari file dependensi: +- **Bahasa**: TypeScript, JavaScript, Python, dll. +- **Framework**: React, Next.js, Express, Django, dll. +- **Versi Runtime**: Node.js, Python, Go, dll. +- **Package Manager**: npm, pnpm, poetry, dll. +- **Dependensi**: Semua dependensi langsung dan dev +- **File Konfigurasi**: Semua file konfigurasi yang terdeteksi + +Terdeteksi dari file seperti: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, dll. + +## Nama Skills yang Dihasilkan Otomatis + +Jika tidak ada nama yang diberikan, Repomix otomatis menghasilkan satu dengan pola ini: + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name (dinormalisasi ke kebab-case) +``` + +Nama Skills akan: +- Dikonversi ke kebab-case (huruf kecil, dipisahkan tanda hubung) +- Dibatasi maksimal 64 karakter +- Dilindungi terhadap path traversal + +## Integrasi dengan Opsi Repomix + +Pembuatan Skills menghormati semua opsi standar Repomix: + +```bash +# Hasilkan Skills dengan pemfilteran file +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# Hasilkan Skills dengan kompresi +repomix --skill-generate --compress + +# Hasilkan Skills dari repository jarak jauh +repomix --remote yamadashy/repomix --skill-generate + +# Hasilkan Skills dengan opsi format output tertentu +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### Skills Hanya Dokumentasi + +Menggunakan `--include`, Anda dapat menghasilkan Skills yang hanya berisi dokumentasi dari repository GitHub. Ini berguna ketika Anda ingin Claude mereferensikan dokumentasi library atau framework tertentu saat mengerjakan kode Anda: + +```bash +# Dokumentasi Claude Code Action +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Dokumentasi Vite +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# Dokumentasi React +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## Keterbatasan + +Opsi `--skill-generate` tidak dapat digunakan dengan: +- `--stdout` - Output Skills memerlukan penulisan ke filesystem +- `--copy` - Output Skills adalah direktori, tidak dapat disalin ke clipboard + +## Menggunakan Skills yang Dihasilkan + +Setelah dihasilkan, Anda dapat menggunakan Skills dengan Claude: + +1. **Claude Code**: Skills otomatis tersedia jika disimpan ke `~/.claude/skills/` atau `.claude/skills/` +2. **Claude Web**: Unggah direktori Skills ke Claude untuk analisis codebase +3. **Berbagi Tim**: Commit `.claude/skills/` ke repository Anda untuk akses seluruh tim + +## Contoh Alur Kerja + +### Membuat Library Referensi Pribadi + +```bash +# Clone dan analisis proyek open source yang menarik +repomix --remote facebook/react --skill-generate react-reference + +# Skills disimpan ke ~/.claude/skills/react-reference/ +# Sekarang Anda dapat mereferensikan codebase React dalam percakapan Claude mana pun +``` + +### Dokumentasi Proyek Tim + +```bash +# Di direktori proyek Anda +cd my-project + +# Hasilkan Skills untuk tim Anda +repomix --skill-generate + +# Pilih "Project Skills" saat diminta +# Skills disimpan ke .claude/skills/repomix-reference-my-project/ + +# Commit dan bagikan dengan tim Anda +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## Sumber Daya Terkait + +- [Plugin Claude Code](/id/guide/claude-code-plugins) - Pelajari tentang plugin Repomix untuk Claude Code +- [Server MCP](/id/guide/mcp-server) - Metode integrasi alternatif +- [Kompresi Kode](/id/guide/code-compress) - Kurangi jumlah token dengan kompresi +- [Konfigurasi](/id/guide/configuration) - Sesuaikan perilaku Repomix diff --git a/website/client/src/ja/guide/agent-skills-generation.md b/website/client/src/ja/guide/agent-skills-generation.md new file mode 100644 index 000000000..0019fb08b --- /dev/null +++ b/website/client/src/ja/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Agent Skills生成 + +Repomixは[Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills)形式の出力を生成できます。これにより、AIアシスタントの再利用可能なコードベースリファレンスとして使用できる構造化されたSkillsディレクトリが作成されます。 + +この機能は、特にリモートリポジトリの実装を参考にしたい場合に真価を発揮します。オープンソースプロジェクトからSkillsを生成することで、自分のコードを書きながらClaudeに特定のパターンや実装を参照させることが簡単にできます。 + +単一のパッキングファイルを生成する代わりに、Skills生成はAIの理解とgrep検索に最適化された複数のリファレンスファイルを含む構造化されたディレクトリを作成します。 + +> [!NOTE] +> これは実験的な機能です。出力形式やオプションは、ユーザーのフィードバックに基づいて今後のリリースで変更される可能性があります。 + +## 基本的な使い方 + +ローカルディレクトリからSkillsを生成します： + +```bash +# カレントディレクトリからSkillsを生成 +repomix --skill-generate + +# カスタムSkills名で生成 +repomix --skill-generate my-project-reference + +# 特定のディレクトリから生成 +repomix path/to/directory --skill-generate + +# リモートリポジトリから生成 +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Skills保存先の選択 + +コマンドを実行すると、RepomixはSkillsの保存先を選択するよう促します： + +1. **Personal Skills** (`~/.claude/skills/`) - マシン上のすべてのプロジェクトで利用可能 +2. **Project Skills** (`.claude/skills/`) - gitを通じてチームと共有 + +Skillsディレクトリが既に存在する場合は、上書きの確認が求められます。 + +> [!TIP] +> Project Skillsを生成する場合は、大きなファイルのコミットを避けるため`.gitignore`への追加を検討してください： +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## 生成される構造 + +Skillsは以下の構造で生成されます： + +```text +.claude/skills// +├── SKILL.md # メインのSkillsメタデータとドキュメント +└── references/ + ├── summary.md # 目的、フォーマット、統計情報 + ├── project-structure.md # 行数付きディレクトリツリー + ├── files.md # すべてのファイル内容（grep検索向け） + └── tech-stack.md # 言語、フレームワーク、依存関係 +``` + +### ファイルの説明 + +#### SKILL.md + +メインのSkillsファイルで、以下を含みます： +- Skills名、説明、プロジェクト情報 +- ファイル数、行数、トークン数 +- Skillsの使用方法の概要 +- ファイルの場所とフォーマットの説明 +- 一般的なユースケースとヒント + +#### references/summary.md + +以下を含みます： +- **目的**: AI利用のためのリファレンスコードベースであることを説明 +- **ファイル構造**: 各リファレンスファイルの内容を文書化 +- **使用ガイドライン**: Skillsを効果的に使用する方法 +- **統計情報**: ファイルタイプ、言語、最大ファイルの内訳 + +#### references/project-structure.md + +ファイル探索を容易にするための、各ファイルの行数付きディレクトリツリー： + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +grep検索に最適化された、シンタックスハイライト付きのすべてのファイル内容： + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +依存関係ファイルから自動検出される技術スタック： +- **言語**: TypeScript、JavaScript、Python など +- **フレームワーク**: React、Next.js、Express、Django など +- **ランタイムバージョン**: Node.js、Python、Go など +- **パッケージマネージャー**: npm、pnpm、poetry など +- **依存関係**: すべての直接依存と開発依存 +- **設定ファイル**: 検出されたすべての設定ファイル + +検出対象ファイル: `package.json`、`requirements.txt`、`Cargo.toml`、`go.mod`、`.nvmrc`、`pyproject.toml` など + +## 自動生成されるSkills名 + +名前が指定されない場合、Repomixは以下のパターンで自動生成します： + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name（ケバブケースに正規化） +``` + +Skills名は： +- ケバブケース（小文字、ハイフン区切り）に変換 +- 最大64文字に制限 +- パストラバーサルから保護 + +## Repomixオプションとの統合 + +Skills生成はすべての標準Repomixオプションを尊重します： + +```bash +# ファイルフィルタリング付きでSkillsを生成 +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# 圧縮付きでSkillsを生成 +repomix --skill-generate --compress + +# リモートリポジトリからSkillsを生成 +repomix --remote yamadashy/repomix --skill-generate + +# 特定の出力フォーマットオプションでSkillsを生成 +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### ドキュメントのみのSkills + +`--include`を使用すると、GitHubリポジトリからドキュメントのみを含むSkillsを生成できます。これは、コードを書きながらClaudeに特定のライブラリやフレームワークのドキュメントを参照させたい場合に便利です： + +```bash +# Claude Code Actionのドキュメント +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Viteのドキュメント +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# Reactのドキュメント +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## 制限事項 + +`--skill-generate`オプションは以下と併用できません： +- `--stdout` - Skills出力にはファイルシステムへの書き込みが必要 +- `--copy` - Skills出力はディレクトリであり、クリップボードにコピー不可 + +## 生成されたSkillsの使用 + +生成されたSkillsはClaudeで以下のように使用できます： + +1. **Claude Code**: `~/.claude/skills/`または`.claude/skills/`に保存された場合、自動的に利用可能 +2. **Claude Web**: コードベース分析のためにSkillsディレクトリをClaudeにアップロード +3. **チーム共有**: チーム全体でアクセスできるように`.claude/skills/`をリポジトリにコミット + +## 使用例ワークフロー + +### 個人用リファレンスライブラリの作成 + +```bash +# 興味のあるオープンソースプロジェクトをクローンして分析 +repomix --remote facebook/react --skill-generate react-reference + +# Skillsは ~/.claude/skills/react-reference/ に保存される +# これで任意のClaudeの会話でReactのコードベースを参照できる +``` + +### チームプロジェクトのドキュメント + +```bash +# プロジェクトディレクトリで +cd my-project + +# チーム用のSkillsを生成 +repomix --skill-generate + +# プロンプトで「Project Skills」を選択 +# Skillsは .claude/skills/repomix-reference-my-project/ に保存される + +# コミットしてチームと共有 +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## 関連リソース + +- [Claude Codeプラグイン](/ja/guide/claude-code-plugins) - Claude Code用のRepomixプラグインについて学ぶ +- [MCPサーバー](/ja/guide/mcp-server) - 代替の統合方法 +- [コード圧縮](/ja/guide/code-compress) - 圧縮でトークン数を削減 +- [設定](/ja/guide/configuration) - Repomixの動作をカスタマイズ diff --git a/website/client/src/ko/guide/agent-skills-generation.md b/website/client/src/ko/guide/agent-skills-generation.md new file mode 100644 index 000000000..34e5e5193 --- /dev/null +++ b/website/client/src/ko/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Agent Skills 생성 + +Repomix는 [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills) 형식의 출력을 생성하여 AI 어시스턴트의 재사용 가능한 코드베이스 참조로 사용할 수 있는 구조화된 Skills 디렉토리를 생성할 수 있습니다. + +이 기능은 특히 원격 저장소의 구현을 참조하고 싶을 때 강력한 힘을 발휘합니다. 오픈소스 프로젝트에서 Skills를 생성하면 자신의 코드를 작성하면서 Claude에게 특정 패턴이나 구현을 참조하도록 쉽게 요청할 수 있습니다. + +단일 패키지 파일을 생성하는 대신, Skills 생성은 AI 이해와 grep 친화적인 검색에 최적화된 여러 참조 파일을 포함하는 구조화된 디렉토리를 생성합니다. + +> [!NOTE] +> 이것은 실험적인 기능입니다. 출력 형식과 옵션은 사용자 피드백에 따라 향후 릴리스에서 변경될 수 있습니다. + +## 기본 사용법 + +로컬 디렉토리에서 Skills 생성: + +```bash +# 현재 디렉토리에서 Skills 생성 +repomix --skill-generate + +# 사용자 정의 Skills 이름으로 생성 +repomix --skill-generate my-project-reference + +# 특정 디렉토리에서 생성 +repomix path/to/directory --skill-generate + +# 원격 저장소에서 생성 +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Skills 저장 위치 선택 + +명령을 실행하면 Repomix가 Skills 저장 위치를 선택하도록 요청합니다: + +1. **Personal Skills** (`~/.claude/skills/`) - 머신의 모든 프로젝트에서 사용 가능 +2. **Project Skills** (`.claude/skills/`) - git을 통해 팀과 공유 + +Skills 디렉토리가 이미 존재하면 덮어쓰기 확인 메시지가 표시됩니다. + +> [!TIP] +> Project Skills를 생성할 때는 대용량 파일의 커밋을 피하기 위해 `.gitignore`에 추가하는 것을 고려하세요: +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## 생성되는 구조 + +Skills는 다음 구조로 생성됩니다: + +```text +.claude/skills// +├── SKILL.md # 메인 Skills 메타데이터 및 문서 +└── references/ + ├── summary.md # 목적, 형식 및 통계 + ├── project-structure.md # 행 수가 포함된 디렉토리 트리 + ├── files.md # 모든 파일 내용 (grep 친화적) + └── tech-stack.md # 언어, 프레임워크, 종속성 +``` + +### 파일 설명 + +#### SKILL.md + +메인 Skills 파일로 다음을 포함합니다: +- Skills 이름, 설명 및 프로젝트 정보 +- 파일 수, 행 수 및 토큰 수 +- Skills 사용 방법 개요 +- 파일 위치 및 형식 설명 +- 일반적인 사용 사례 및 팁 + +#### references/summary.md + +포함 내용: +- **목적**: AI 사용을 위한 참조 코드베이스임을 설명 +- **파일 구조**: 각 참조 파일의 내용 문서화 +- **사용 지침**: Skills를 효과적으로 사용하는 방법 +- **통계**: 파일 유형, 언어 및 가장 큰 파일별 분류 + +#### references/project-structure.md + +파일 탐색을 위한 파일당 행 수가 포함된 디렉토리 트리: + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +grep 친화적인 검색에 최적화된 구문 강조 헤더가 있는 모든 파일 내용: + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +종속성 파일에서 자동 감지된 기술 스택: +- **언어**: TypeScript, JavaScript, Python 등 +- **프레임워크**: React, Next.js, Express, Django 등 +- **런타임 버전**: Node.js, Python, Go 등 +- **패키지 관리자**: npm, pnpm, poetry 등 +- **종속성**: 모든 직접 및 개발 종속성 +- **설정 파일**: 감지된 모든 설정 파일 + +감지 대상 파일: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml` 등. + +## 자동 생성 Skills 이름 + +이름이 제공되지 않으면 Repomix가 다음 패턴으로 자동 생성합니다: + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name (kebab-case로 정규화) +``` + +Skills 이름은: +- kebab-case(소문자, 하이픈 구분)로 변환 +- 최대 64자로 제한 +- 경로 탐색으로부터 보호 + +## Repomix 옵션과의 통합 + +Skills 생성은 모든 표준 Repomix 옵션을 지원합니다: + +```bash +# 파일 필터링과 함께 Skills 생성 +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# 압축과 함께 Skills 생성 +repomix --skill-generate --compress + +# 원격 저장소에서 Skills 생성 +repomix --remote yamadashy/repomix --skill-generate + +# 특정 출력 형식 옵션과 함께 Skills 생성 +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### 문서 전용 Skills + +`--include`를 사용하면 GitHub 저장소의 문서만 포함된 Skills를 생성할 수 있습니다. 코드를 작성하면서 Claude가 특정 라이브러리나 프레임워크 문서를 참조하도록 할 때 유용합니다: + +```bash +# Claude Code Action 문서 +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Vite 문서 +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# React 문서 +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## 제한 사항 + +`--skill-generate` 옵션은 다음과 함께 사용할 수 없습니다: +- `--stdout` - Skills 출력은 파일 시스템에 쓰기가 필요함 +- `--copy` - Skills 출력은 디렉토리이므로 클립보드에 복사할 수 없음 + +## 생성된 Skills 사용 + +생성 후 Claude에서 Skills를 사용할 수 있습니다: + +1. **Claude Code**: `~/.claude/skills/` 또는 `.claude/skills/`에 저장되면 자동으로 사용 가능 +2. **Claude Web**: 코드베이스 분석을 위해 Skills 디렉토리를 Claude에 업로드 +3. **팀 공유**: 팀 전체 액세스를 위해 `.claude/skills/`를 저장소에 커밋 + +## 예제 워크플로우 + +### 개인 참조 라이브러리 만들기 + +```bash +# 흥미로운 오픈소스 프로젝트를 클론하고 분석 +repomix --remote facebook/react --skill-generate react-reference + +# Skills가 ~/.claude/skills/react-reference/에 저장됨 +# 이제 모든 Claude 대화에서 React 코드베이스를 참조할 수 있음 +``` + +### 팀 프로젝트 문서화 + +```bash +# 프로젝트 디렉토리에서 +cd my-project + +# 팀을 위한 Skills 생성 +repomix --skill-generate + +# 프롬프트에서 "Project Skills" 선택 +# Skills가 .claude/skills/repomix-reference-my-project/에 저장됨 + +# 커밋하고 팀과 공유 +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## 관련 리소스 + +- [Claude Code 플러그인](/ko/guide/claude-code-plugins) - Claude Code용 Repomix 플러그인에 대해 알아보기 +- [MCP 서버](/ko/guide/mcp-server) - 대체 통합 방법 +- [코드 압축](/ko/guide/code-compress) - 압축으로 토큰 수 줄이기 +- [설정](/ko/guide/configuration) - Repomix 동작 사용자 지정 diff --git a/website/client/src/pt-br/guide/agent-skills-generation.md b/website/client/src/pt-br/guide/agent-skills-generation.md new file mode 100644 index 000000000..e4a29139d --- /dev/null +++ b/website/client/src/pt-br/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Geração de Agent Skills + +O Repomix pode gerar saída no formato [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills), criando um diretório estruturado de Skills que pode ser usado como referência de código reutilizável para assistentes de IA. + +Este recurso é particularmente poderoso quando você deseja referenciar implementações de repositórios remotos. Ao gerar Skills de projetos de código aberto, você pode facilmente pedir ao Claude para referenciar padrões ou implementações específicas enquanto trabalha em seu próprio código. + +Em vez de gerar um único arquivo empacotado, a geração de Skills cria um diretório estruturado com múltiplos arquivos de referência otimizados para compreensão de IA e busca compatível com grep. + +> [!NOTE] +> Este é um recurso experimental. O formato de saída e as opções podem mudar em versões futuras com base no feedback dos usuários. + +## Uso Básico + +Gerar Skills do seu diretório local: + +```bash +# Gerar Skills do diretório atual +repomix --skill-generate + +# Gerar com nome personalizado de Skills +repomix --skill-generate my-project-reference + +# Gerar de um diretório específico +repomix path/to/directory --skill-generate + +# Gerar de repositório remoto +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Seleção de Local dos Skills + +Quando você executa o comando, o Repomix solicita que você escolha onde salvar os Skills: + +1. **Personal Skills** (`~/.claude/skills/`) - Disponível em todos os projetos na sua máquina +2. **Project Skills** (`.claude/skills/`) - Compartilhado com sua equipe via git + +Se o diretório de Skills já existir, será solicitada confirmação para sobrescrever. + +> [!TIP] +> Ao gerar Project Skills, considere adicioná-los ao `.gitignore` para evitar fazer commit de arquivos grandes: +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## Estrutura Gerada + +Os Skills são gerados com a seguinte estrutura: + +```text +.claude/skills// +├── SKILL.md # Metadados principais e documentação dos Skills +└── references/ + ├── summary.md # Propósito, formato e estatísticas + ├── project-structure.md # Árvore de diretórios com contagem de linhas + ├── files.md # Todo o conteúdo dos arquivos (compatível com grep) + └── tech-stack.md # Linguagens, frameworks, dependências +``` + +### Descrições dos Arquivos + +#### SKILL.md + +O arquivo principal dos Skills contém: +- Nome dos Skills, descrição e informações do projeto +- Contagem de arquivos, linhas e tokens +- Visão geral de como usar os Skills +- Localizações dos arquivos e explicação do formato +- Casos de uso comuns e dicas + +#### references/summary.md + +Contém: +- **Propósito**: Explica que é uma base de código de referência para consumo de IA +- **Estrutura de Arquivos**: Documenta o conteúdo de cada arquivo de referência +- **Diretrizes de Uso**: Como usar os Skills efetivamente +- **Estatísticas**: Divisão por tipo de arquivo, linguagem e maiores arquivos + +#### references/project-structure.md + +Árvore de diretórios com contagem de linhas por arquivo para fácil descoberta: + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +Todo o conteúdo dos arquivos com cabeçalhos de destaque de sintaxe, otimizado para busca compatível com grep: + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +Stack tecnológico auto-detectado dos arquivos de dependências: +- **Linguagens**: TypeScript, JavaScript, Python, etc. +- **Frameworks**: React, Next.js, Express, Django, etc. +- **Versões de Runtime**: Node.js, Python, Go, etc. +- **Gerenciador de Pacotes**: npm, pnpm, poetry, etc. +- **Dependências**: Todas as dependências diretas e de desenvolvimento +- **Arquivos de Configuração**: Todos os arquivos de configuração detectados + +Detectado de arquivos como: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, etc. + +## Nomes de Skills Auto-Gerados + +Se nenhum nome for fornecido, o Repomix auto-gera um usando este padrão: + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name (normalizado para kebab-case) +``` + +Os nomes de Skills são: +- Convertidos para kebab-case (minúsculas, separados por hífen) +- Limitados a no máximo 64 caracteres +- Protegidos contra path traversal + +## Integração com Opções do Repomix + +A geração de Skills respeita todas as opções padrão do Repomix: + +```bash +# Gerar Skills com filtragem de arquivos +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# Gerar Skills com compressão +repomix --skill-generate --compress + +# Gerar Skills de repositório remoto +repomix --remote yamadashy/repomix --skill-generate + +# Gerar Skills com opções específicas de formato de saída +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### Skills Apenas de Documentação + +Usando `--include`, você pode gerar Skills contendo apenas a documentação de um repositório GitHub. Isso é útil quando você quer que o Claude referencie documentação específica de biblioteca ou framework enquanto trabalha em seu código: + +```bash +# Documentação do Claude Code Action +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Documentação do Vite +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# Documentação do React +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## Limitações + +A opção `--skill-generate` não pode ser usada com: +- `--stdout` - A saída de Skills requer escrita no sistema de arquivos +- `--copy` - A saída de Skills é um diretório, não pode ser copiado para a área de transferência + +## Usando Skills Gerados + +Uma vez gerados, você pode usar os Skills com o Claude: + +1. **Claude Code**: Os Skills estão automaticamente disponíveis se salvos em `~/.claude/skills/` ou `.claude/skills/` +2. **Claude Web**: Faça upload do diretório de Skills para o Claude para análise de base de código +3. **Compartilhamento de Equipe**: Faça commit de `.claude/skills/` no seu repositório para acesso de toda a equipe + +## Exemplo de Workflow + +### Criando uma Biblioteca de Referência Pessoal + +```bash +# Clone e analise um projeto de código aberto interessante +repomix --remote facebook/react --skill-generate react-reference + +# Os Skills são salvos em ~/.claude/skills/react-reference/ +# Agora você pode referenciar a base de código do React em qualquer conversa com o Claude +``` + +### Documentação de Projeto de Equipe + +```bash +# No seu diretório de projeto +cd my-project + +# Gere Skills para sua equipe +repomix --skill-generate + +# Escolha "Project Skills" quando solicitado +# Os Skills são salvos em .claude/skills/repomix-reference-my-project/ + +# Faça commit e compartilhe com sua equipe +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## Recursos Relacionados + +- [Plugins do Claude Code](/pt-br/guide/claude-code-plugins) - Aprenda sobre plugins do Repomix para Claude Code +- [Servidor MCP](/pt-br/guide/mcp-server) - Método de integração alternativo +- [Compressão de Código](/pt-br/guide/code-compress) - Reduzir contagem de tokens com compressão +- [Configuração](/pt-br/guide/configuration) - Personalizar comportamento do Repomix diff --git a/website/client/src/public/schemas/1.10.1/schema.json b/website/client/src/public/schemas/1.10.1/schema.json new file mode 100644 index 000000000..53d1e305d --- /dev/null +++ b/website/client/src/public/schemas/1.10.1/schema.json @@ -0,0 +1,163 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "$schema": { + "type": "string" + }, + "input": { + "type": "object", + "properties": { + "maxFileSize": { + "type": "number" + } + }, + "additionalProperties": false + }, + "output": { + "type": "object", + "properties": { + "filePath": { + "type": "string" + }, + "style": { + "type": "string", + "enum": [ + "xml", + "markdown", + "json", + "plain" + ] + }, + "parsableStyle": { + "type": "boolean" + }, + "headerText": { + "type": "string" + }, + "instructionFilePath": { + "type": "string" + }, + "fileSummary": { + "type": "boolean" + }, + "directoryStructure": { + "type": "boolean" + }, + "files": { + "type": "boolean" + }, + "removeComments": { + "type": "boolean" + }, + "removeEmptyLines": { + "type": "boolean" + }, + "compress": { + "type": "boolean" + }, + "topFilesLength": { + "type": "number" + }, + "showLineNumbers": { + "type": "boolean" + }, + "truncateBase64": { + "type": "boolean" + }, + "copyToClipboard": { + "type": "boolean" + }, + "includeEmptyDirectories": { + "type": "boolean" + }, + "includeFullDirectoryStructure": { + "type": "boolean" + }, + "tokenCountTree": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "git": { + "type": "object", + "properties": { + "sortByChanges": { + "type": "boolean" + }, + "sortByChangesMaxCommits": { + "type": "number" + }, + "includeDiffs": { + "type": "boolean" + }, + "includeLogs": { + "type": "boolean" + }, + "includeLogsCount": { + "type": "number" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + }, + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "ignore": { + "type": "object", + "properties": { + "useGitignore": { + "type": "boolean" + }, + "useDotIgnore": { + "type": "boolean" + }, + "useDefaultPatterns": { + "type": "boolean" + }, + "customPatterns": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "security": { + "type": "object", + "properties": { + "enableSecurityCheck": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "tokenCount": { + "type": "object", + "properties": { + "encoding": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "title": "Repomix Configuration", + "description": "Schema for repomix.config.json configuration file" +} \ No newline at end of file diff --git a/website/client/src/vi/guide/agent-skills-generation.md b/website/client/src/vi/guide/agent-skills-generation.md new file mode 100644 index 000000000..398608af2 --- /dev/null +++ b/website/client/src/vi/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Tạo Agent Skills + +Repomix có thể tạo đầu ra theo định dạng [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills), tạo một thư mục Skills có cấu trúc có thể được sử dụng làm tham chiếu codebase có thể tái sử dụng cho các trợ lý AI. + +Tính năng này đặc biệt mạnh mẽ khi bạn muốn tham chiếu các triển khai từ các repository từ xa. Bằng cách tạo Skills từ các dự án mã nguồn mở, bạn có thể dễ dàng yêu cầu Claude tham chiếu các mẫu hoặc triển khai cụ thể trong khi làm việc trên code của riêng bạn. + +Thay vì tạo một file đóng gói duy nhất, việc tạo Skills sẽ tạo một thư mục có cấu trúc với nhiều file tham chiếu được tối ưu hóa cho sự hiểu biết của AI và tìm kiếm tương thích grep. + +> [!NOTE] +> Đây là một tính năng thử nghiệm. Định dạng đầu ra và các tùy chọn có thể thay đổi trong các bản phát hành tương lai dựa trên phản hồi của người dùng. + +## Sử Dụng Cơ Bản + +Tạo Skills từ thư mục cục bộ của bạn: + +```bash +# Tạo Skills từ thư mục hiện tại +repomix --skill-generate + +# Tạo với tên Skills tùy chỉnh +repomix --skill-generate my-project-reference + +# Tạo từ thư mục cụ thể +repomix path/to/directory --skill-generate + +# Tạo từ repository từ xa +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Chọn Vị Trí Lưu Skills + +Khi bạn chạy lệnh, Repomix sẽ yêu cầu bạn chọn nơi lưu Skills: + +1. **Personal Skills** (`~/.claude/skills/`) - Có sẵn trên tất cả các dự án trên máy của bạn +2. **Project Skills** (`.claude/skills/`) - Chia sẻ với nhóm của bạn qua git + +Nếu thư mục Skills đã tồn tại, bạn sẽ được yêu cầu xác nhận ghi đè. + +> [!TIP] +> Khi tạo Project Skills, hãy cân nhắc thêm chúng vào `.gitignore` để tránh commit các file lớn: +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## Cấu Trúc Được Tạo + +Skills được tạo với cấu trúc sau: + +```text +.claude/skills// +├── SKILL.md # Metadata chính và tài liệu Skills +└── references/ + ├── summary.md # Mục đích, định dạng và thống kê + ├── project-structure.md # Cây thư mục với số dòng + ├── files.md # Tất cả nội dung file (tương thích grep) + └── tech-stack.md # Ngôn ngữ, framework, dependencies +``` + +### Mô Tả File + +#### SKILL.md + +File Skills chính chứa: +- Tên Skills, mô tả và thông tin dự án +- Số lượng file, số dòng và số token +- Tổng quan về cách sử dụng Skills +- Vị trí file và giải thích định dạng +- Các trường hợp sử dụng phổ biến và mẹo + +#### references/summary.md + +Chứa: +- **Mục đích**: Giải thích đây là codebase tham chiếu cho AI sử dụng +- **Cấu trúc File**: Tài liệu nội dung của mỗi file tham chiếu +- **Hướng dẫn Sử dụng**: Cách sử dụng Skills hiệu quả +- **Thống kê**: Phân tích theo loại file, ngôn ngữ và file lớn nhất + +#### references/project-structure.md + +Cây thư mục với số dòng mỗi file để dễ dàng khám phá: + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +Tất cả nội dung file với header syntax highlighting, được tối ưu hóa cho tìm kiếm tương thích grep: + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +Tech stack được tự động phát hiện từ các file dependency: +- **Ngôn ngữ**: TypeScript, JavaScript, Python, v.v. +- **Framework**: React, Next.js, Express, Django, v.v. +- **Phiên bản Runtime**: Node.js, Python, Go, v.v. +- **Package Manager**: npm, pnpm, poetry, v.v. +- **Dependencies**: Tất cả dependency trực tiếp và dev +- **File Cấu hình**: Tất cả file cấu hình được phát hiện + +Được phát hiện từ các file như: `package.json`, `requirements.txt`, `Cargo.toml`, `go.mod`, `.nvmrc`, `pyproject.toml`, v.v. + +## Tên Skills Tự Động Tạo + +Nếu không cung cấp tên, Repomix tự động tạo một tên theo mẫu này: + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name (chuẩn hóa thành kebab-case) +``` + +Tên Skills sẽ: +- Được chuyển đổi thành kebab-case (chữ thường, phân cách bằng dấu gạch ngang) +- Giới hạn tối đa 64 ký tự +- Được bảo vệ chống path traversal + +## Tích Hợp với Các Tùy Chọn Repomix + +Việc tạo Skills tuân thủ tất cả các tùy chọn tiêu chuẩn của Repomix: + +```bash +# Tạo Skills với lọc file +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# Tạo Skills với nén +repomix --skill-generate --compress + +# Tạo Skills từ repository từ xa +repomix --remote yamadashy/repomix --skill-generate + +# Tạo Skills với các tùy chọn định dạng đầu ra cụ thể +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### Skills Chỉ Tài Liệu + +Sử dụng `--include`, bạn có thể tạo Skills chỉ chứa tài liệu từ một repository GitHub. Điều này hữu ích khi bạn muốn Claude tham chiếu tài liệu thư viện hoặc framework cụ thể trong khi làm việc trên code của bạn: + +```bash +# Tài liệu Claude Code Action +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Tài liệu Vite +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# Tài liệu React +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## Hạn Chế + +Tùy chọn `--skill-generate` không thể sử dụng với: +- `--stdout` - Đầu ra Skills yêu cầu ghi vào hệ thống file +- `--copy` - Đầu ra Skills là thư mục, không thể sao chép vào clipboard + +## Sử Dụng Skills Đã Tạo + +Sau khi tạo, bạn có thể sử dụng Skills với Claude: + +1. **Claude Code**: Skills tự động khả dụng nếu được lưu vào `~/.claude/skills/` hoặc `.claude/skills/` +2. **Claude Web**: Tải thư mục Skills lên Claude để phân tích codebase +3. **Chia sẻ Nhóm**: Commit `.claude/skills/` vào repository của bạn để cả nhóm truy cập + +## Quy Trình Làm Việc Mẫu + +### Tạo Thư Viện Tham Chiếu Cá Nhân + +```bash +# Clone và phân tích một dự án mã nguồn mở thú vị +repomix --remote facebook/react --skill-generate react-reference + +# Skills được lưu vào ~/.claude/skills/react-reference/ +# Bây giờ bạn có thể tham chiếu codebase của React trong bất kỳ cuộc hội thoại Claude nào +``` + +### Tài Liệu Dự Án Nhóm + +```bash +# Trong thư mục dự án của bạn +cd my-project + +# Tạo Skills cho nhóm của bạn +repomix --skill-generate + +# Chọn "Project Skills" khi được yêu cầu +# Skills được lưu vào .claude/skills/repomix-reference-my-project/ + +# Commit và chia sẻ với nhóm của bạn +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## Tài Nguyên Liên Quan + +- [Plugin Claude Code](/vi/guide/claude-code-plugins) - Tìm hiểu về các plugin Repomix cho Claude Code +- [MCP Server](/vi/guide/mcp-server) - Phương pháp tích hợp thay thế +- [Nén Code](/vi/guide/code-compress) - Giảm số token bằng nén +- [Cấu hình](/vi/guide/configuration) - Tùy chỉnh hành vi Repomix diff --git a/website/client/src/zh-cn/guide/agent-skills-generation.md b/website/client/src/zh-cn/guide/agent-skills-generation.md new file mode 100644 index 000000000..93b308aaa --- /dev/null +++ b/website/client/src/zh-cn/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Agent Skills 生成 + +Repomix 可以生成 [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills) 格式的输出，创建一个结构化的 Skills 目录，可作为 AI 助手的可重用代码库参考。 + +当您想要参考远程仓库的实现时，此功能特别强大。通过从开源项目生成 Skills，您可以轻松让 Claude 在您编写代码时参考特定的模式或实现。 + +Skills 生成不是生成单个打包文件，而是创建一个包含多个参考文件的结构化目录，这些文件针对 AI 理解和 grep 友好搜索进行了优化。 + +> [!NOTE] +> 这是一个实验性功能。输出格式和选项可能会根据用户反馈在未来版本中发生变化。 + +## 基本用法 + +从本地目录生成 Skills： + +```bash +# 从当前目录生成 Skills +repomix --skill-generate + +# 使用自定义 Skills 名称生成 +repomix --skill-generate my-project-reference + +# 从特定目录生成 +repomix path/to/directory --skill-generate + +# 从远程仓库生成 +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Skills 保存位置选择 + +运行命令时，Repomix 会提示您选择 Skills 的保存位置： + +1. **Personal Skills** (`~/.claude/skills/`) - 在您机器上的所有项目中可用 +2. **Project Skills** (`.claude/skills/`) - 通过 git 与团队共享 + +如果 Skills 目录已存在，系统会提示您确认是否覆盖。 + +> [!TIP] +> 生成 Project Skills 时，建议将其添加到 `.gitignore` 以避免提交大文件： +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## 生成的结构 + +Skills 按以下结构生成： + +```text +.claude/skills// +├── SKILL.md # Skills 主元数据和文档 +└── references/ + ├── summary.md # 目的、格式和统计信息 + ├── project-structure.md # 带行数的目录树 + ├── files.md # 所有文件内容（grep 友好） + └── tech-stack.md # 语言、框架、依赖项 +``` + +### 文件说明 + +#### SKILL.md + +主 Skills 文件包含： +- Skills 名称、描述和项目信息 +- 文件数、行数和 token 数 +- Skills 使用方法概述 +- 文件位置和格式说明 +- 常见用例和提示 + +#### references/summary.md + +包含： +- **目的**：说明这是供 AI 使用的参考代码库 +- **文件结构**：记录每个参考文件的内容 +- **使用指南**：如何有效使用 Skills +- **统计信息**：按文件类型、语言和最大文件的分类 + +#### references/project-structure.md + +带有每个文件行数的目录树，便于文件发现： + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +所有带语法高亮头的文件内容，针对 grep 友好搜索优化： + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +从依赖文件自动检测的技术栈： +- **语言**：TypeScript、JavaScript、Python 等 +- **框架**：React、Next.js、Express、Django 等 +- **运行时版本**：Node.js、Python、Go 等 +- **包管理器**：npm、pnpm、poetry 等 +- **依赖项**：所有直接依赖和开发依赖 +- **配置文件**：所有检测到的配置文件 + +检测来源文件：`package.json`、`requirements.txt`、`Cargo.toml`、`go.mod`、`.nvmrc`、`pyproject.toml` 等。 + +## 自动生成的 Skills 名称 + +如果未提供名称，Repomix 会使用以下模式自动生成： + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name（规范化为 kebab-case） +``` + +Skills 名称会： +- 转换为 kebab-case（小写，连字符分隔） +- 限制最多 64 个字符 +- 防止路径遍历攻击 + +## 与 Repomix 选项集成 + +Skills 生成支持所有标准 Repomix 选项： + +```bash +# 使用文件过滤生成 Skills +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# 使用压缩生成 Skills +repomix --skill-generate --compress + +# 从远程仓库生成 Skills +repomix --remote yamadashy/repomix --skill-generate + +# 使用特定输出格式选项生成 Skills +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### 仅文档 Skills + +使用 `--include`，您可以生成仅包含 GitHub 仓库文档的 Skills。当您希望 Claude 在编写代码时参考特定库或框架的文档时，这很有用： + +```bash +# Claude Code Action 文档 +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Vite 文档 +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# React 文档 +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## 限制 + +`--skill-generate` 选项不能与以下选项一起使用： +- `--stdout` - Skills 输出需要写入文件系统 +- `--copy` - Skills 输出是目录，无法复制到剪贴板 + +## 使用生成的 Skills + +生成后，您可以在 Claude 中使用这些 Skills： + +1. **Claude Code**：如果保存到 `~/.claude/skills/` 或 `.claude/skills/`，Skills 会自动可用 +2. **Claude Web**：将 Skills 目录上传到 Claude 进行代码库分析 +3. **团队共享**：将 `.claude/skills/` 提交到仓库供团队使用 + +## 示例工作流 + +### 创建个人参考库 + +```bash +# 克隆并分析一个有趣的开源项目 +repomix --remote facebook/react --skill-generate react-reference + +# Skills 保存到 ~/.claude/skills/react-reference/ +# 现在您可以在任何 Claude 对话中参考 React 的代码库 +``` + +### 团队项目文档 + +```bash +# 在您的项目目录中 +cd my-project + +# 为团队生成 Skills +repomix --skill-generate + +# 提示时选择 "Project Skills" +# Skills 保存到 .claude/skills/repomix-reference-my-project/ + +# 提交并与团队共享 +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## 相关资源 + +- [Claude Code 插件](/zh-cn/guide/claude-code-plugins) - 了解 Claude Code 的 Repomix 插件 +- [MCP 服务器](/zh-cn/guide/mcp-server) - 替代集成方法 +- [代码压缩](/zh-cn/guide/code-compress) - 通过压缩减少 token 数 +- [配置](/zh-cn/guide/configuration) - 自定义 Repomix 行为 diff --git a/website/client/src/zh-tw/guide/agent-skills-generation.md b/website/client/src/zh-tw/guide/agent-skills-generation.md new file mode 100644 index 000000000..04cc94c5a --- /dev/null +++ b/website/client/src/zh-tw/guide/agent-skills-generation.md @@ -0,0 +1,213 @@ +# Agent Skills 生成 + +Repomix 可以生成 [Claude Agent Skills](https://docs.anthropic.com/en/docs/claude-code/skills) 格式的輸出，建立一個結構化的 Skills 目錄，可作為 AI 助手的可重複使用程式碼庫參考。 + +當您想要參考遠端儲存庫的實作時，此功能特別強大。透過從開源專案生成 Skills，您可以輕鬆讓 Claude 在您編寫程式碼時參考特定的模式或實作。 + +Skills 生成不是生成單一打包檔案，而是建立一個包含多個參考檔案的結構化目錄，這些檔案針對 AI 理解和 grep 友善搜尋進行了最佳化。 + +> [!NOTE] +> 這是一個實驗性功能。輸出格式和選項可能會根據使用者回饋在未來版本中發生變化。 + +## 基本用法 + +從本地目錄生成 Skills： + +```bash +# 從當前目錄生成 Skills +repomix --skill-generate + +# 使用自訂 Skills 名稱生成 +repomix --skill-generate my-project-reference + +# 從特定目錄生成 +repomix path/to/directory --skill-generate + +# 從遠端儲存庫生成 +repomix --remote https://github.com/user/repo --skill-generate +``` + +## Skills 儲存位置選擇 + +執行命令時，Repomix 會提示您選擇 Skills 的儲存位置： + +1. **Personal Skills** (`~/.claude/skills/`) - 在您機器上的所有專案中可用 +2. **Project Skills** (`.claude/skills/`) - 透過 git 與團隊共享 + +如果 Skills 目錄已存在，系統會提示您確認是否覆蓋。 + +> [!TIP] +> 生成 Project Skills 時，建議將其新增到 `.gitignore` 以避免提交大型檔案： +> ```gitignore +> .claude/skills/repomix-reference-*/ +> ``` + +## 生成的結構 + +Skills 按以下結構生成： + +```text +.claude/skills// +├── SKILL.md # Skills 主要中繼資料和文件 +└── references/ + ├── summary.md # 目的、格式和統計資訊 + ├── project-structure.md # 帶行數的目錄樹 + ├── files.md # 所有檔案內容（grep 友善） + └── tech-stack.md # 語言、框架、相依性 +``` + +### 檔案說明 + +#### SKILL.md + +主要 Skills 檔案包含： +- Skills 名稱、描述和專案資訊 +- 檔案數、行數和 token 數 +- Skills 使用方法概述 +- 檔案位置和格式說明 +- 常見用例和提示 + +#### references/summary.md + +包含： +- **目的**：說明這是供 AI 使用的參考程式碼庫 +- **檔案結構**：記錄每個參考檔案的內容 +- **使用指南**：如何有效使用 Skills +- **統計資訊**：按檔案類型、語言和最大檔案的分類 + +#### references/project-structure.md + +帶有每個檔案行數的目錄樹，便於檔案發現： + +```text +src/ + index.ts (42 lines) + utils/ + helpers.ts (128 lines) + math.ts (87 lines) +``` + +#### references/files.md + +所有帶語法高亮標頭的檔案內容，針對 grep 友善搜尋最佳化： + +````markdown +## File: src/index.ts +```typescript +import { sum } from './utils/helpers'; + +export function main() { + console.log(sum(1, 2)); +} +``` +```` + +#### references/tech-stack.md + +從相依性檔案自動偵測的技術堆疊： +- **語言**：TypeScript、JavaScript、Python 等 +- **框架**：React、Next.js、Express、Django 等 +- **執行環境版本**：Node.js、Python、Go 等 +- **套件管理器**：npm、pnpm、poetry 等 +- **相依性**：所有直接相依和開發相依 +- **設定檔**：所有偵測到的設定檔 + +偵測來源檔案：`package.json`、`requirements.txt`、`Cargo.toml`、`go.mod`、`.nvmrc`、`pyproject.toml` 等。 + +## 自動生成的 Skills 名稱 + +如果未提供名稱，Repomix 會使用以下模式自動生成： + +```bash +repomix src/ --skill-generate # → repomix-reference-src +repomix --remote user/repo --skill-generate # → repomix-reference-repo +repomix --skill-generate CustomName # → custom-name（規範化為 kebab-case） +``` + +Skills 名稱會： +- 轉換為 kebab-case（小寫，連字號分隔） +- 限制最多 64 個字元 +- 防止路徑遍歷攻擊 + +## 與 Repomix 選項整合 + +Skills 生成支援所有標準 Repomix 選項： + +```bash +# 使用檔案過濾生成 Skills +repomix --skill-generate --include "src/**/*.ts" --ignore "**/*.test.ts" + +# 使用壓縮生成 Skills +repomix --skill-generate --compress + +# 從遠端儲存庫生成 Skills +repomix --remote yamadashy/repomix --skill-generate + +# 使用特定輸出格式選項生成 Skills +repomix --skill-generate --remove-comments --remove-empty-lines +``` + +### 僅文件 Skills + +使用 `--include`，您可以生成僅包含 GitHub 儲存庫文件的 Skills。當您希望 Claude 在編寫程式碼時參考特定函式庫或框架的文件時，這很有用： + +```bash +# Claude Code Action 文件 +repomix --remote https://github.com/anthropics/claude-code-action --include docs --skill-generate + +# Vite 文件 +repomix --remote https://github.com/vitejs/vite --include docs --skill-generate + +# React 文件 +repomix --remote https://github.com/reactjs/react.dev --include src/content --skill-generate +``` + +## 限制 + +`--skill-generate` 選項不能與以下選項一起使用： +- `--stdout` - Skills 輸出需要寫入檔案系統 +- `--copy` - Skills 輸出是目錄，無法複製到剪貼簿 + +## 使用生成的 Skills + +生成後，您可以在 Claude 中使用這些 Skills： + +1. **Claude Code**：如果儲存到 `~/.claude/skills/` 或 `.claude/skills/`，Skills 會自動可用 +2. **Claude Web**：將 Skills 目錄上傳到 Claude 進行程式碼庫分析 +3. **團隊共享**：將 `.claude/skills/` 提交到儲存庫供團隊使用 + +## 範例工作流程 + +### 建立個人參考庫 + +```bash +# 複製並分析一個有趣的開源專案 +repomix --remote facebook/react --skill-generate react-reference + +# Skills 儲存到 ~/.claude/skills/react-reference/ +# 現在您可以在任何 Claude 對話中參考 React 的程式碼庫 +``` + +### 團隊專案文件 + +```bash +# 在您的專案目錄中 +cd my-project + +# 為團隊生成 Skills +repomix --skill-generate + +# 提示時選擇 "Project Skills" +# Skills 儲存到 .claude/skills/repomix-reference-my-project/ + +# 提交並與團隊共享 +git add .claude/skills/ +git commit -m "Add codebase reference Skills" +``` + +## 相關資源 + +- [Claude Code 外掛](/zh-tw/guide/claude-code-plugins) - 了解 Claude Code 的 Repomix 外掛 +- [MCP 伺服器](/zh-tw/guide/mcp-server) - 替代整合方法 +- [程式碼壓縮](/zh-tw/guide/code-compress) - 透過壓縮減少 token 數 +- [設定](/zh-tw/guide/configuration) - 自訂 Repomix 行為