diff --git a/README.md b/README.md index 94b5c524..0863d6b2 100644 --- a/README.md +++ b/README.md @@ -1233,11 +1233,31 @@ Repomix provides a ready-to-use **Repomix Explorer** skill that enables AI codin #### Quick Install -```bash -npx add-skill yamadashy/repomix --skill repomix-explorer +For Claude Code, install the official Repomix Explorer plugin: + +```text +/plugin marketplace add yamadashy/repomix +/plugin install repomix-explorer@repomix ``` -This command installs the skill to your AI assistant's skills directory (e.g., `.claude/skills/`), making it immediately available. +For Codex, Cursor, OpenClaw, and other Agent Skills-compatible assistants, install the standalone skill with the Skills CLI: + +```bash +npx skills add yamadashy/repomix --skill repomix-explorer +``` + +To target a specific assistant, pass `--agent`: + +```bash +npx skills add yamadashy/repomix --skill repomix-explorer --agent codex +npx skills add yamadashy/repomix --skill repomix-explorer --agent openclaw +``` + +For Hermes Agent, install the single-file skill with Hermes' native skills command: + +```bash +hermes skills install https://raw.githubusercontent.com/yamadashy/repomix/main/.claude/skills/repomix-explorer/SKILL.md +``` #### What It Does diff --git a/website/client/src/en/guide/faq.md b/website/client/src/en/guide/faq.md index 0a97c6cc..a7342f0b 100644 --- a/website/client/src/en/guide/faq.md +++ b/website/client/src/en/guide/faq.md @@ -45,10 +45,17 @@ For OpenClaw or other MCP-compatible agents, use the same command and arguments If your assistant supports the Agent Skills format, you can also install the Repomix Explorer skill instead of configuring MCP: ```bash -npx add-skill yamadashy/repomix --skill repomix-explorer +npx skills add yamadashy/repomix --skill repomix-explorer ``` -Use the MCP server when you want the agent to call Repomix tools during a session. Use [Repomix Explorer Skill](/guide/repomix-explorer-skill) when you want a reusable natural-language workflow for exploring local or remote codebases. +For Claude Code, use the dedicated Repomix Explorer plugin instead: + +```text +/plugin marketplace add yamadashy/repomix +/plugin install repomix-explorer@repomix +``` + +Use the MCP server when you want the agent to call Repomix tools during a session. Use [Repomix Explorer Skill](/guide/repomix-explorer-skill) when you want a reusable natural-language workflow for exploring local or remote codebases; that guide also includes the Hermes Agent `hermes skills install` command. Use the Claude Code plugin when you want namespaced slash commands such as `/repomix-explorer:explore-local`. ### Does Repomix work with private repositories? diff --git a/website/client/src/en/guide/repomix-explorer-skill.md b/website/client/src/en/guide/repomix-explorer-skill.md index 197403a5..663e265c 100644 --- a/website/client/src/en/guide/repomix-explorer-skill.md +++ b/website/client/src/en/guide/repomix-explorer-skill.md @@ -11,11 +11,37 @@ This skill is designed for Claude Code and other AI assistants that support the ## Quick Install -```bash -npx add-skill yamadashy/repomix --skill repomix-explorer +For Claude Code, install the official Repomix Explorer plugin: + +```text +/plugin marketplace add yamadashy/repomix +/plugin install repomix-explorer@repomix ``` -This command installs the skill to your AI assistant's skills directory (e.g., `.claude/skills/`), making it immediately available. +The Claude Code plugin provides namespaced commands such as `/repomix-explorer:explore-local` and `/repomix-explorer:explore-remote`. See [Claude Code Plugins](/guide/claude-code-plugins) for the full plugin setup. + +For Codex, Cursor, OpenClaw, and other Agent Skills-compatible assistants, install the standalone skill with the Skills CLI: + +```bash +npx skills add yamadashy/repomix --skill repomix-explorer +``` + +To target a specific assistant, pass `--agent`: + +```bash +npx skills add yamadashy/repomix --skill repomix-explorer --agent codex +npx skills add yamadashy/repomix --skill repomix-explorer --agent openclaw +``` + +The Skills CLI installs the skill into the selected assistant's skills directory, such as `.agents/skills/`, `.claude/skills/`, or `skills/` for OpenClaw projects. + +For Hermes Agent, install the single-file skill with Hermes' native skills command: + +```bash +hermes skills install https://raw.githubusercontent.com/yamadashy/repomix/main/.claude/skills/repomix-explorer/SKILL.md +``` + +If you use Hermes primarily for repository analysis, the [MCP Server](/guide/mcp-server) setup is also a good option because it runs Repomix directly as an MCP server. ## What It Does