Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -898,6 +898,8 @@ To configure Repomix as an MCP server in [Claude Code](https://docs.anthropic.co
claude mcp add repomix -- npx -y repomix --mcp
```

Alternatively, you can use the official Repomix plugins (see [Claude Code Plugins](#claude-code-plugins) section below).

**Using Docker instead of npx:**

You can use Docker as an alternative to npx for running Repomix as an MCP server:
Expand Down Expand Up @@ -993,6 +995,77 @@ When running as an MCP server, Repomix provides the following tools:
- Validates paths and ensures they are absolute
- Useful for exploring project structure and understanding codebase organization

### Claude Code Plugins

Repomix provides official plugins for [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview) that integrate seamlessly with the AI-powered development environment.

#### Available Plugins

**1. repomix-mcp** (MCP Server Plugin)

Foundation plugin that provides AI-powered codebase analysis through MCP server integration.

**Features:**
- Pack local and remote repositories
- Search through packed outputs
- Read files with built-in security scanning (Secretlint)
- Automatic Tree-sitter compression (~70% token reduction)

**2. repomix-commands** (Slash Commands Plugin)

Provides convenient slash commands for quick operations with natural language support.

**Available Commands:**
- `/repomix-commands:pack-local` - Pack local codebase with various options
- `/repomix-commands:pack-remote` - Pack and analyze remote GitHub repositories

**Example usage:**
```text
/repomix-commands:pack-local
Pack this project as markdown with compression

/repomix-commands:pack-remote yamadashy/repomix
Pack only TypeScript files from the yamadashy/repomix repository
```

#### Installation

**1. Add the Repomix plugin marketplace:**

```text
/plugin marketplace add yamadashy/repomix
```

**2. Install plugins:**

```text
# Install MCP server plugin (recommended foundation)
/plugin install repomix-mcp@repomix

# Install commands plugin (extends functionality)
/plugin install repomix-commands@repomix
```

**Note**: The `repomix-mcp` plugin is recommended as a foundation, and `repomix-commands` extends it with convenient slash commands. While you can install them independently, using both provides the most comprehensive experience.

**Alternatively, use the interactive plugin installer:**

```bash
/plugin
```

This will open an interactive interface where you can browse and install available plugins.

#### Benefits

- **Seamless Integration**: Claude can directly analyze codebases without manual preparation
- **Natural Language**: Use conversational commands instead of remembering CLI syntax
- **Always Latest**: Automatically uses `npx repomix@latest` for up-to-date features
- **Security Built-in**: Automatic Secretlint scanning prevents sensitive data exposure
- **Token Optimization**: Tree-sitter compression for large codebases

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

## ⚙️ Configuration

Repomix supports multiple configuration file formats for flexibility and ease of use.
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configDe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configDe = defineConfig({
text: 'Fortgeschritten',
items: [
{ text: 'MCP-Server', link: '/de/guide/mcp-server' },
{ text: 'Claude Code Plugins', link: '/de/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/de/guide/github-actions' },
{ text: 'Repomix als Bibliothek verwenden', link: '/de/guide/development/using-repomix-as-a-library' },
{ text: 'KI-unterstützte Entwicklungstipps', link: '/de/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configEnUs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configEnUs = defineConfig({
text: 'Advanced',
items: [
{ text: 'MCP Server', link: '/guide/mcp-server' },
{ text: 'Claude Code Plugins', link: '/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/guide/github-actions' },
{ text: 'Using Repomix as a Library', link: '/guide/development/using-repomix-as-a-library' },
{ text: 'AI-Assisted Development Tips', link: '/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configEs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configEs = defineConfig({
text: 'Avanzado',
items: [
{ text: 'Servidor MCP', link: '/es/guide/mcp-server' },
{ text: 'Plugins de Claude Code', link: '/es/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/es/guide/github-actions' },
{ text: 'Usar Repomix como Biblioteca', link: '/es/guide/development/using-repomix-as-a-library' },
{ text: 'Consejos para Desarrollo Asistido por IA', link: '/es/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configFr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configFr = defineConfig({
text: 'Avancé',
items: [
{ text: 'Serveur MCP', link: '/fr/guide/mcp-server' },
{ text: 'Plugins Claude Code', link: '/fr/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/fr/guide/github-actions' },
{
text: 'Utiliser Repomix comme bibliothèque',
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configHi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configHi = defineConfig({
text: 'उन्नत',
items: [
{ text: 'MCP सर्वर', link: '/hi/guide/mcp-server' },
{ text: 'Claude Code प्लगइन्स', link: '/hi/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/hi/guide/github-actions' },
{ text: 'Repomix को लाइब्रेरी के रूप में उपयोग', link: '/hi/guide/development/using-repomix-as-a-library' },
{ text: 'AI-सहायक विकास टिप्स', link: '/hi/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configId.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configId = defineConfig({
text: 'Lanjutan',
items: [
{ text: 'Server MCP', link: '/id/guide/mcp-server' },
{ text: 'Plugin Claude Code', link: '/id/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/id/guide/github-actions' },
{
text: 'Menggunakan Repomix sebagai Library',
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configJa.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export const configJa = defineConfig({
text: '高度な使い方',
items: [
{ text: 'MCPサーバー', link: '/ja/guide/mcp-server' },
{ text: 'Claude Codeプラグイン', link: '/ja/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/ja/guide/github-actions' },
{ text: 'ライブラリとしての使用', link: '/ja/guide/development/using-repomix-as-a-library' },
{ text: 'AI支援開発のヒント', link: '/ja/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configKo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configKo = defineConfig({
text: '고급',
items: [
{ text: 'MCP 서버', link: '/ko/guide/mcp-server' },
{ text: 'Claude Code 플러그인', link: '/ko/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/ko/guide/github-actions' },
{ text: 'Repomix를 라이브러리로 사용하기', link: '/ko/guide/development/using-repomix-as-a-library' },
{ text: 'AI 지원 개발 팁', link: '/ko/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configPtBr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configPtBr = defineConfig({
text: 'Avançado',
items: [
{ text: 'Servidor MCP', link: '/pt-br/guide/mcp-server' },
{ text: 'Plugins do Claude Code', link: '/pt-br/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/pt-br/guide/github-actions' },
{ text: 'Usando Repomix como Biblioteca', link: '/pt-br/guide/development/using-repomix-as-a-library' },
{ text: 'Dicas de Desenvolvimento Assistido por IA', link: '/pt-br/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configVi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configVi = defineConfig({
text: 'Nâng cao',
items: [
{ text: 'Máy chủ MCP', link: '/vi/guide/mcp-server' },
{ text: 'Plugin Claude Code', link: '/vi/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/vi/guide/github-actions' },
{
text: 'Sử dụng Repomix như một thư viện',
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configZhCn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ export const configZhCn = defineConfig({
text: '高级',
items: [
{ text: 'MCP 服务器', link: '/zh-cn/guide/mcp-server' },
{ text: 'Claude Code 插件', link: '/zh-cn/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/zh-cn/guide/github-actions' },
{ text: '作为库使用 Repomix', link: '/zh-cn/guide/development/using-repomix-as-a-library' },
{ text: 'AI辅助开发技巧', link: '/zh-cn/guide/tips/best-practices' },
Expand Down
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configZhTw.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export const configZhTw = defineConfig({
text: '高級',
items: [
{ text: 'MCP 伺服器', link: '/zh-tw/guide/mcp-server' },
{ text: 'Claude Code 外掛', link: '/zh-tw/guide/claude-code-plugins' },
{ text: 'GitHub Actions', link: '/zh-tw/guide/github-actions' },
{ text: '作為庫使用 Repomix', link: '/zh-tw/guide/development/using-repomix-as-a-library' },
{ text: 'AI輔助開發技巧', link: '/zh-tw/guide/tips/best-practices' },
Expand Down
112 changes: 112 additions & 0 deletions website/client/src/de/guide/claude-code-plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# Claude Code Plugins

Repomix bietet offizielle Plugins für [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview), die sich nahtlos in die KI-gestützte Entwicklungsumgebung integrieren. Diese Plugins ermöglichen es Ihnen, Codebases direkt innerhalb von Claude Code mithilfe natürlichsprachlicher Befehle zu analysieren und zu verpacken.

## Verfügbare Plugins

### 1. repomix-mcp (MCP-Server-Plugin)

Basis-Plugin, das KI-gestützte Codebase-Analyse durch MCP-Server-Integration bereitstellt.

**Funktionen:**
- Lokale und entfernte Repositories verpacken
- Verpackte Ausgaben durchsuchen
- Dateien mit integriertem Sicherheitsscan lesen ([Secretlint](https://github.com/secretlint/secretlint))
- Automatische Tree-sitter-Kompression (ca. 70% Token-Reduktion)

### 2. repomix-commands (Slash-Befehls-Plugin)

Bietet praktische Slash-Befehle mit Unterstützung für natürliche Sprache.

**Verfügbare Befehle:**
- `/repomix-commands:pack-local` - Lokale Codebase mit verschiedenen Optionen verpacken
- `/repomix-commands:pack-remote` - Entfernte GitHub-Repositories verpacken und analysieren

## Installation

### 1. Repomix-Plugin-Marktplatz hinzufügen

Fügen Sie zunächst den Repomix-Plugin-Marktplatz zu Claude Code hinzu:

```text
/plugin marketplace add yamadashy/repomix
```

### 2. Plugins installieren

Installieren Sie die Plugins mit den folgenden Befehlen:

```text
# MCP-Server-Plugin installieren (empfohlene Basis)
/plugin install repomix-mcp@repomix

# Befehls-Plugin installieren (erweitert Funktionalität)
/plugin install repomix-commands@repomix
```

::: tip Plugin-Beziehung
Das `repomix-mcp`-Plugin wird als Basis empfohlen, und `repomix-commands` erweitert es mit praktischen Slash-Befehlen. Obwohl Sie sie unabhängig installieren können, bietet die Verwendung beider die umfassendste Erfahrung.
:::

### Alternative: Interaktive Installation

Sie können auch das interaktive Plugin-Installationsprogramm verwenden:

```text
/plugin
```

Dies öffnet eine interaktive Oberfläche, in der Sie verfügbare Plugins durchsuchen und installieren können.

## Verwendungsbeispiele

### Lokale Codebase verpacken

Verwenden Sie den Befehl `/repomix-commands:pack-local` mit natürlichsprachlichen Anweisungen:

```text
/repomix-commands:pack-local
Dieses Projekt im Markdown-Format mit Kompression verpacken
```

Weitere Beispiele:
- "Nur das src-Verzeichnis verpacken"
- "TypeScript-Dateien mit Zeilennummern verpacken"
- "Ausgabe im JSON-Format generieren"

### Entferntes Repository verpacken

Verwenden Sie den Befehl `/repomix-commands:pack-remote`, um GitHub-Repositories zu analysieren:

```text
/repomix-commands:pack-remote yamadashy/repomix
Nur TypeScript-Dateien aus dem Repository yamadashy/repomix verpacken
```

Weitere Beispiele:
- "Main-Branch mit Kompression verpacken"
- "Nur Dokumentationsdateien einschließen"
- "Bestimmte Verzeichnisse verpacken"

## Verwandte Ressourcen

- [MCP-Server-Dokumentation](/guide/mcp-server) - Erfahren Sie mehr über den zugrunde liegenden MCP-Server
- [Konfiguration](/guide/configuration) - Repomix-Verhalten anpassen
- [Sicherheit](/guide/security) - Sicherheitsfunktionen verstehen
- [Befehlszeilenoptionen](/guide/command-line-options) - Verfügbare CLI-Optionen

## Plugin-Quellcode

Der Plugin-Quellcode ist im Repomix-Repository verfügbar:

- [Plugin-Marktplatz](https://github.com/yamadashy/repomix/tree/main/.claude-plugin)
- [MCP-Plugin](https://github.com/yamadashy/repomix/tree/main/.claude/plugins/repomix-mcp)
- [Befehls-Plugin](https://github.com/yamadashy/repomix/tree/main/.claude/plugins/repomix-commands)

## Feedback und Support

Wenn Sie Probleme haben oder Vorschläge für die Claude Code Plugins haben:

- [Issue auf GitHub öffnen](https://github.com/yamadashy/repomix/issues)
- [Unserer Discord-Community beitreten](https://discord.gg/wNYzTwZFku)
- [Bestehende Diskussionen ansehen](https://github.com/yamadashy/repomix/discussions)
2 changes: 2 additions & 0 deletions website/client/src/de/guide/mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ Um Repomix als MCP-Server in [Claude Code](https://docs.anthropic.com/en/docs/cl
claude mcp add repomix -- npx -y repomix --mcp
```

Alternativ können Sie die **offiziellen Repomix-Plugins** für ein komfortableres Erlebnis verwenden. Die Plugins bieten natürlichsprachliche Befehle und eine einfachere Einrichtung. Weitere Informationen finden Sie in der Dokumentation [Claude Code Plugins](/de/guide/claude-code-plugins).

### Docker anstelle von npx verwenden

Anstatt npx zu verwenden, können Sie auch Docker verwenden, um Repomix als MCP-Server auszuführen:
Expand Down
Loading
Loading