Commit Graph

260 Commits

Author SHA1 Message Date
Kazuki Yamada 3f15a97748 docs(website): Use Hermes Agent product name
intent(naming): user clarified that Hermes Agent should be written with its formal product name.

decision(naming): updated README and localized Repomix Explorer Skill docs to use Hermes Agent in prose while keeping the hermes CLI command and ~/.hermes path unchanged.
2026-05-03 19:50:34 +09:00
Kazuki Yamada f50f55e9b7 docs(website): Update skill install guidance
intent(agent-skills): user clarified that Repomix Explorer should use the current npx skills add command and asked to prefer dedicated install flows where supported.

decision(claude-code): documented the Claude Code plugin install path as the recommended Claude Code-specific flow because Repomix ships an official repomix-explorer plugin marketplace entry.

decision(agent-skills): kept npx skills add for Codex, Cursor, OpenClaw, and other Agent Skills-compatible assistants because the Skills CLI targets those agent directories from the official Repomix repository source.

decision(hermes): added Hermes Agent's native hermes skills install command using the raw Repomix Explorer SKILL.md because Hermes documents direct URL skill installs.
2026-05-03 19:15:51 +09:00
Kazuki Yamada 97d743688f docs(readme): Fix Codecov badge token
The previous commit (71164907) used an incorrect graph token in the
Codecov badge URL, which prevented the badge from rendering. Replace
it with the correct token from codecov.io.
2026-04-11 19:45:47 +09:00
Kazuki Yamada 7116490789 ci: Enable Codecov Test Analytics and update badge token
Add JUnit XML reporting to the test-coverage job and upload results
via codecov/test-results-action. This enables Test Analytics features
(test run times, failure rates, flaky test detection, and PR comments
with failed test summaries).

Also update the README Codecov badge URL to include the graph token,
following Codecov's new recommended badge format.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-11 19:38:21 +09:00
Kazuki Yamada 5c55597512 docs(core): Replace tiktoken references with gpt-tokenizer
Update all documentation, build configuration, and source comments
to reflect the completed migration from tiktoken to gpt-tokenizer.

- Update tokenCount.encoding description to say "OpenAI-compatible
  tokenization" with gpt-tokenizer link (README + 15 language docs)
- Remove tiktoken from bundling external deps list since
  gpt-tokenizer is pure JS (README + 15 language docs)
- Remove tiktoken COPY from Dockerfile and external from bundle.mjs
- Simplify source code comments removing migration artifacts
- Regenerate scripts/memory/package-lock.json

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-06 15:37:26 +09:00
Kazuki Yamada 8d95c51c0c docs(website): Convert reference-style lists to tables in English docs
Convert option/parameter lists to tables for improved scannability
in reference documentation:

- command-line-options.md: Convert CLI options to tables (7 sections),
  add missing --remote-trust-config and Agent Skills Generation options
- mcp-server.md: Convert 4 MCP tool parameter lists to
  Parameter/Required/Default/Description tables
- agent-skills-generation.md: Convert file descriptions to
  File/Purpose/Contents table
- README.md: Mirror the same CLI option table conversions

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-05 12:41:09 +09:00
Kazuki Yamada 7c652d131f chore(sponsors): remove Tower sponsorship
Tower (git-tower) cancelled their sponsorship, so removing their logo,
links, and image assets from README and website.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-05 01:09:01 +09:00
Kazuki Yamada d172dc5866 docs(website): Remove "unofficial" from Repomix Desktop descriptions
Community projects are inherently community-maintained, so the
"unofficial" qualifier is redundant. Remove it from README and all
15 language versions of community-projects.md.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-04 22:16:29 +09:00
Kazuki Yamada 44b539af71 docs(readme): Update tech-stack.md to tech-stacks.md in skill docs
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-28 00:49:42 +09:00
Kazuki Yamada f9612c449c docs(website): Document --config absolute path requirement in remote mode
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-22 23:35:20 +09:00
Kazuki Yamada 88933d58a7 docs(readme): Document --remote-trust-config and security behavior
Add CLI option reference and a security note explaining that remote
repository config files are not loaded by default, with instructions
for opting in via --remote-trust-config or REPOMIX_REMOTE_TRUST_CONFIG.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-22 23:35:20 +09:00
yamadashy 72d53a4a9e style(website): Use Tower promotional banner instead of logo banner
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-12 00:42:40 +09:00
yamadashy f4ee120169 style(readme): Update Tower sponsor logo to icon and text banner
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-12 00:41:14 +09:00
Kazuki Yamada da45659214 chore(sponsors): Remove Tuple from sponsor list
Tuple has ended their sponsorship, so remove their entry from
README.md and website sponsors section.
2026-03-03 23:52:33 +09:00
Kazuki Yamada 416289bea4 docs(cli): Address PR review feedback
- Add explicit --skill-output and --force mention in README description
- Add trailing periods to Spanish option descriptions
2026-02-08 20:58:54 +09:00
Kazuki Yamada 49c4c784d7 docs(cli): Add non-interactive --skill-generate documentation
Document --skill-output and --force options for non-interactive
skill generation in CI pipelines and automation scripts.

Closes #1142, Closes #1012
2026-02-08 18:07:29 +09:00
Kazuki Yamada 6c8700a143 docs: update Tower sponsor icon to light version 2026-02-05 23:40:41 +09:00
Kazuki Yamada 88e226783e docs: add Tower as a sponsor
Add Tower (git-tower.com) to the README sponsors section.
Tower is the most powerful Git client for Mac and Windows.
2026-02-04 22:56:00 +09:00
Kazuki Yamada 5eb7bbdf5a docs(readme): Add Repomix Explorer skill documentation
Document the ready-to-use Repomix Explorer skill that enables AI coding
assistants to analyze and explore codebases. Include quick install command
using add-skill and describe what the skill enables.
2026-01-18 22:42:11 +09:00
Kazuki Yamada bca69920ef docs(readme): Clarify WASM file requirement in bundling section
Change "for code compression feature" to "required for code compression feature"
for consistency with other documentation pages as suggested in PR review.
2026-01-04 22:28:34 +09:00
Kazuki Yamada 79d3876c16 docs: Add bundling guide for library usage 2026-01-04 21:32:55 +09:00
Kazuki Yamada 1071755b96 docs(releases): Add v1.11.0 release notes and fix splitOutput docs
- Add release notes for v1.11.0 featuring --split-output option
- Add splitOutput config option to README
- Fix splitOutput description in configuration docs (all 14 languages)
  to clarify that config uses numbers (bytes) while CLI accepts
  human-readable sizes like 500kb or 2mb
2025-12-24 00:11:01 +09:00
Kazuki Yamada 09e8d39916 docs(readme,website): Add decimal size examples for --split-output
Update documentation to reflect support for decimal values like 1.5mb
in size specifications.
2025-12-21 21:56:39 +09:00
Kazuki Yamada f143aebc4f docs(readme): Add Splitting Output for Large Codebases section
Document --split-output feature with:
- Use case (AI Studio's 1MB file size limit)
- Usage example and file naming convention
- Note about directory-based grouping
2025-12-21 21:56:39 +09:00
Dango233 3216450bd5 docs(cli): Document --split-output
Add the new split output flag to README and website docs, including examples and the config option.
2025-12-21 21:56:39 +09:00
Kazuki Yamada c47b61d0c6 docs(website): Fix code block language specifications in agent-skills-generation docs
- Add 'gitignore' language to .gitignore example in TIP block
- Add 'text' language to directory structure examples
- Fix nested fenced code blocks in files.md section (use 4 backticks)
- Update kebab-case example to use 'CustomName' instead of 'custom-name'

Applied to: en, de, es, fr, hi, id
2025-12-12 23:28:17 +09:00
Claude b4fa5b4f84 docs: Fix incorrect CLI usage examples for skill-generate
Fix usage examples where directory argument was incorrectly placed:
- `repomix --skill-generate path/to/directory` (wrong)
- `repomix path/to/directory --skill-generate` (correct)

The --skill-generate [name] option takes an optional skill name,
not a directory path. Directories are positional arguments.
2025-12-12 13:53:28 +00:00
Claude d7f9c53a4c docs: Improve Agent Skills Generation introduction
- Add explanation that this feature is particularly powerful for
  referencing implementations from remote repositories
- Remove redundant "What is Agent Skills Generation?" section
- Merge explanation into the introduction paragraph
2025-12-12 13:53:28 +00:00
Claude 0d861db0dd docs: Update terminology to use Agent Skills consistently
Update all skill-generate documentation to use "Agent Skills" or "Skills"
instead of "skill" for consistency:

- README.md: Update section titles and content
- English website doc: Update to "Agent Skills Generation"
- Japanese website doc: Update to "Agent Skills生成"
- Sidebar labels: Update both English and Japanese labels
2025-12-12 13:53:28 +00:00
Claude 781fdcc1c5 docs(readme): Add skill-generate feature documentation
Add documentation for the --skill-generate feature introduced in PR #998:
- Add --skill-generate option to Command Line Options section
- Add dedicated Skill Generation section with usage examples
- Document generated structure (SKILL.md and references/)
- Include auto-generated skill names and integration examples
2025-12-12 13:53:27 +00:00
Kazuki Yamada 7ea753ca4f fix(readme): Use text instead of bash for Claude Code commands
Change code block language from bash to text for /plugin command
since it's a Claude Code-specific command, not a shell command.
2025-11-29 22:37:40 +09:00
Kazuki Yamada a69afdb9a1 docs(readme): Reorder Claude Code Plugins section for better UX
Move Installation section above Available Plugins for easier onboarding.
Also fix plugin name from 'repomix-explorer:explorer' to 'repomix-explorer'.
2025-11-29 19:54:24 +09:00
Kazuki Yamada 265a51028d docs(website): Add Privacy Policy page
Add a dedicated Privacy Policy page to the website, addressing user
feedback about privacy information being hard to find on repomix.com.

Changes:
- Create Privacy Policy page with content from README
- Add sidebar links for all supported languages
- Non-English pages include English content via @include
- Simplify README Privacy Policy section to link only

Related Discord feedback requested clearer privacy documentation
on the website for users who need to verify data handling before
using Repomix in their work environment.
2025-11-29 19:24:08 +09:00
Kazuki Yamada d2ed827260 docs: Correct ignore files priority order documentation
Updated priority order documentation in README.md and all website configuration guides (12 languages) to accurately reflect how globby handles ignore files:

- Merged items 2-4 into a single "Ignore files" category
- Clarified that directory hierarchy determines priority (deeper directories win)
- Explained that files in the same directory are merged in no particular order
- This reflects globby's actual behavior where fast-glob returns files in filesystem order

The previous documentation incorrectly implied a fixed priority order between .repomixignore, .ignore, and .gitignore files, when in fact they are all merged together at the same level with priority determined by directory depth only.
2025-11-08 20:42:56 +09:00
Kazuki Yamada bb7fae2b45 feat(core): Add .ignore file support
This PR adds support for .ignore files, which are used by tools like ripgrep and the silver searcher. This allows users to maintain a single .ignore file that works across multiple tools instead of maintaining separate ignore files.

Changes:
- Add ignore.useDotIgnore config option (default: true)
- Add --no-dot-ignore CLI flag to disable .ignore file usage
- Update ignore file priority: .repomixignore > .ignore > .gitignore > default patterns
- Add comprehensive tests for .ignore file handling
- Update documentation to reflect new .ignore file support

The .ignore file is enabled by default but can be disabled via configuration or CLI flag, maintaining backward compatibility.

Resolves #937
2025-11-08 15:51:21 +09:00
Kazuki Yamada b80cf4e2a7 refactor(plugins): Rename repository-explorer to repomix-explorer and simplify agent name
Renamed the repository explorer plugin from `repository-explorer` to
`repomix-explorer` for better alignment with the Repomix ecosystem naming
convention. Also simplified the agent name from `repository-explorer` to
`explorer` for brevity.

Changes:
- Plugin name: `repository-explorer` → `repomix-explorer`
- Agent name: `repository-explorer` → `explorer`
- Fully qualified name: `repository-explorer:repository-explorer` → `repomix-explorer:explorer`

This change affects:
- Plugin directory (.claude/plugins/repository-explorer → repomix-explorer)
- Agent file (agents/repository-explorer.md → agents/explorer.md)
- plugin.json metadata
- All command files (explore-local.md, explore-remote.md)
- repomix-commands plugin references
- marketplace.json
- README.md
- Website documentation (12 language versions)

The new naming provides:
1. Better consistency with other Repomix plugins (repomix-mcp, repomix-commands)
2. Clearer brand association with Repomix
3. More concise agent name that's easier to reference

BREAKING CHANGE: Users need to update their plugin installation:
- Old: `/plugin install repository-explorer@repomix`
- New: `/plugin install repomix-explorer@repomix`

Commands are also updated:
- Old: `/repository-explorer:explore-local`, `/repository-explorer:explore-remote`
- New: `/repomix-explorer:explore-local`, `/repomix-explorer:explore-remote`
2025-10-25 12:38:05 +09:00
Kazuki Yamada 86e1c6a2e8 docs(plugins): Use fully qualified agent name repository-explorer:repository-explorer
Updated all documentation to use the correct fully qualified agent name
format (plugin-name:agent-name) for the repository-explorer agent.

Changed from:
- repository-explorer

To:
- repository-explorer:repository-explorer

This change ensures consistency with Claude Code's agent naming convention
where agents are referenced using the format plugin-name:agent-name when
the plugin name and agent name are the same.

Files updated:
- README.md
- Plugin documentation (6 files in .claude/plugins/)
- Website documentation (12 language versions)
2025-10-25 00:20:34 +09:00
Kazuki Yamada 2cc2e8177e docs: Add repository-explorer plugin to documentation
Add comprehensive documentation for the new repository-explorer plugin
across README and website documentation (English and Japanese versions).

Changes:
- README.md: Add repository-explorer as the 3rd plugin with features,
  commands, and usage examples
- Update installation section with repository-explorer install command
- Update plugin relationship note to mention all three plugins

Website documentation (en/ja):
- Add repository-explorer plugin section with features and commands
- Add AI-powered analysis usage examples for local and remote exploration
- Update installation instructions and plugin relationship tips
- Add repository-explorer to plugin source code links

Other changes:
- Bump marketplace.json version to 1.0.2
- Bump repomix-commands plugin version to 1.0.2

The repository-explorer plugin provides AI-powered codebase analysis
that intelligently explores repositories using natural language commands
while managing context efficiently through incremental grep and read
operations.
2025-10-20 23:16:57 +09:00
Kazuki Yamada 00d19121ed docs(readme): Add output.includeFullDirectoryStructure to configuration options table 2025-10-18 14:44:33 +09:00
Kazuki Yamada 052f85e636 docs(readme): Add documentation for --include-full-directory-structure flag
Add CLI option documentation for the --include-full-directory-structure flag
in the README. This flag allows users to display the complete directory tree
in output, including files not matched by --include patterns, providing full
project context while maintaining focused file selection.
2025-10-17 17:50:08 -07:00
Kazuki Yamada e44d62d09f docs(readme): Clarify Claude Code Plugins documentation details
- Update example repository name to be consistent
- Clarify plugin installation order and relationship
- Add 'text' language tag to code blocks
- Explain recommended plugin installation process

Addresses review comments from Gemini Code Assist and Copilot
2025-10-14 00:23:41 +09:00
Kazuki Yamada f41b32d4c4 docs(readme): Reorganize Claude Code Plugins section placement
Move the Claude Code Plugins section after the Available MCP Tools section for better documentation flow. This creates a more logical structure:

1. MCP Server Integration (overview)
2. Available MCP Tools (technical details)
3. Claude Code Plugins (user-friendly integration)
4. Configuration

This organization helps users understand the MCP foundation before learning about the convenient Claude Code plugin wrappers.
2025-10-14 00:18:20 +09:00
Kazuki Yamada 711d5b09aa fix(docs): Use correct command format with plugin prefix
Update command examples to use the actual format with plugin prefix:
- /pack-local -> /repomix-commands:pack-local
- /pack-remote -> /repomix-commands:pack-remote

This matches the actual command format shown in Claude Code.
2025-10-14 00:14:54 +09:00
Kazuki Yamada 2903796b09 docs(readme): Update plugin installation instructions
Update installation section to use correct Claude Code plugin commands:
- Use /plugin marketplace add for adding marketplace
- Use /plugin install with @marketplace syntax
- Add interactive /plugin command option

Remove outdated file path-based installation instructions.
2025-10-14 00:06:09 +09:00
Kazuki Yamada 54f4e5caab docs(readme): Add Claude Code Plugins section
Add comprehensive documentation for Claude Code plugins:

- Overview of repomix-mcp and repomix-commands plugins
- Installation instructions for Claude Code
- Example usage with natural language commands
- Benefits and features of using plugins
- Cross-reference from MCP Server Integration section

This provides users with clear guidance on how to use Repomix with Claude Code through the official plugin system.
2025-10-14 00:03:10 +09:00
Kazuki Yamada 5b707f53a9 docs(config): Add $schema to example configuration
Added $schema property to the example configuration to demonstrate best
practice and encourage users to enable schema validation for better IDE
support.
2025-10-12 18:04:14 +09:00
Kazuki Yamada ead0235c80 docs(config): Add schema validation section to README
Added documentation for JSON schema validation feature that was present in
the website docs but missing from README. Users can now enable auto-completion
and validation in their editors by adding the $schema property to their
configuration file.
2025-10-12 18:02:33 +09:00
Kazuki Yamada 4f21d324fa docs(config): Remove duplicate benefit from TypeScript section
Removed 'Real-time error detection while editing' as it's redundant with
'Full TypeScript type checking in your IDE' which already implies real-time
error detection.
2025-10-12 17:57:26 +09:00
Kazuki Yamada 4fd64574fd docs(config): Simplify JavaScript Configuration section
Reduced the JavaScript Configuration section to a single line noting it works
the same as TypeScript. Removed redundant examples since the behavior and
usage are identical to TypeScript configuration.
2025-10-12 17:53:40 +09:00
Kazuki Yamada dc886d9f62 docs(config): Remove 'Recommended' label from TypeScript section 2025-10-12 17:52:28 +09:00