docs: add stdin behavior explanation across all languages#702
Conversation
When using --stdin, specified files are effectively added to include patterns.
This means normal include and ignore behavior still applies - files specified
via stdin will still be excluded if they match ignore patterns.
Updates:
- README.md
- All 12 language versions of website/client/src/{lang}/guide/usage.md
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughDocumentation for the Changes
Possibly related PRs
✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
Claude finished @yamadashy's task —— View job PR Review: Documentation Updates for stdin behaviorI've analyzed the documentation changes for Todo List:
Review SummaryThis PR successfully addresses a common source of user confusion about ✅ StrengthsClear Technical Explanation: The key addition clarifies that files specified via Comprehensive Coverage:
Translation Quality: The translations maintain semantic consistency across all languages:
Strategic Placement: The explanation is positioned right after the stdin examples but before the NOTE, making it discoverable when users are learning about stdin functionality. ✅ Technical AccuracyThe explanation correctly describes Repomix's stdin behavior:
This prevents the common misconception that stdin provides a way to bypass ignore rules. 🎯 Suggestions for EnhancementMinor Wording Refinement: Consider slightly expanding the explanation for maximum clarity: When using `--stdin`, the specified files are effectively added to the include patterns. This means that the normal include and ignore behavior still applies - files specified via stdin will still be excluded if they match ignore patterns (such as those in .gitignore or .repomixignore).The addition of "(such as those in .gitignore or .repomixignore)" would make the ignore sources more concrete for users. 📝 Minor Observations
Overall AssessmentThis is a high-quality documentation improvement that will significantly reduce user confusion about stdin behavior. The implementation is thorough, technically accurate, and well-translated across all supported languages. Recommendation: ✅ Approve - This PR successfully clarifies important behavioral details and enhances the user experience without any negative impact. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to clarify the behavior of the --stdin option across the project’s English README and all translated usage guides. It explains that files passed via --stdin are added to include patterns and therefore still subject to ignore rules.
- Updated README.md with a clarification paragraph.
- Updated usage.md files in 12 languages to maintain consistent explanation.
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updated clarification of --stdin behavior |
| website/client/src/en/guide/usage.md | Updated usage instructions for --stdin behavior |
| website/client/src/es/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/de/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/fr/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/hi/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/id/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/ja/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/ko/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/pt-br/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/vi/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/zh-cn/guide/usage.md | Translated update: clarified --stdin file inclusion |
| website/client/src/zh-tw/guide/usage.md | Translated update: clarified --stdin file inclusion |
Comments suppressed due to low confidence (2)
README.md:258
- [nitpick] Consider replacing the dash '-' with a semicolon or a period to clearly separate the two independent clauses for improved clarity.
When using `--stdin`, the specified files are effectively added to the include patterns. This means that the normal include and ignore behavior still applies - files specified via stdin will still be excluded if they match ignore patterns.
website/client/src/en/guide/usage.md:82
- [nitpick] Consider replacing the dash '-' with a semicolon or a period to clearly separate the two independent clauses, enhancing readability.
When using `--stdin`, the specified files are effectively added to the include patterns. This means that the normal include and ignore behavior still applies - files specified via stdin will still be excluded if they match ignore patterns.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Comprehensive documentation update across 12 language versions to clarify --stdin behavior in Repomix, explaining how it interacts with file patterns and ignore rules.
- Added technical explanation in
README.mdabout--stdinfile handling - Updated all language versions in
website/client/src/*/guide/usage.mdwith consistent stdin behavior documentation - Maintained language-specific idioms while ensuring technical accuracy of stdin behavior explanation
- Strategically placed new content between stdin examples and path resolution sections
- Preserved documentation structure and formatting across all translations
13 files reviewed, 1 comment
Edit PR Review Bot Settings | Greptile
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #702 +/- ##
=======================================
Coverage 90.36% 90.36%
=======================================
Files 99 99
Lines 5561 5561
Branches 1186 1186
=======================================
Hits 5025 5025
Misses 536 536 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @yamadashy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the documentation for the --stdin option in Repomix. It clarifies that files specified via stdin are treated as include patterns and are still subject to ignore rules, ensuring users understand the consistent behavior across all file selection methods. The changes include updates to the README.md file and the usage.md documentation for all supported languages on the website.
Highlights
- --stdin behavior: Clarified that when using
--stdin, files are added to include patterns and are still subject to ignore rules. - Documentation: Updated README.md and website documentation (usage.md) for all 12 supported languages (en, ja, de, es, fr, hi, id, ko, pt-br, vi, zh-cn, zh-tw).
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
website/client/src/zh-cn/guide/usage.md (1)
82-82: Minor wording polish for fluencyConsider replacing “正常的包含和忽略行为” with “常规的 include 与 ignore 行为” to sound more natural and to avoid the adverb-missing warning flagged by LanguageTool.
-这意味着正常的包含和忽略行为仍然适用 +这意味着常规的 include 与 ignore 行为仍然适用website/client/src/en/guide/usage.md (1)
82-83: Minor wording & punctuation polishConsider a slight re-phrasing for flow and using an em-dash (
—) instead of-to match the rest of the docs:-This means that the normal include and ignore behavior still applies - files specified via stdin will still be excluded if they match ignore patterns. +This means the normal include-/ignore-behavior still applies —files provided via stdin will still be excluded if they match ignore patterns.Purely stylistic; feel free to ignore if you prefer the current wording.
website/client/src/zh-tw/guide/usage.md (1)
82-83: 用語潤飾建議
正常的包含和忽略行為讀起來稍顯直譯，可改為更口語的表達：-這意味著正常的包含和忽略行為仍然適用 - 通過 stdin 指定的文件如果匹配忽略模式仍會被排除。 +也就是說，一般的包含與忽略規則仍然生效——若透過 stdin 指定的檔案符合忽略模式，仍會被排除。改善可讀性，不影響技術準確性。
website/client/src/es/guide/usage.md (1)
82-83: Punctuation tweak for consistencyThroughout the Spanish docs an em-dash (
—) is usually used for parenthetical remarks. To stay consistent:-Esto significa que el comportamiento normal de inclusión e ignorar sigue aplicando - los archivos especificados vía stdin aún serán excluidos si coinciden con patrones de ignorar. +Esto significa que el comportamiento normal de inclusión e ignorar sigue aplicando —los archivos especificados vía stdin aún se excluirán si coinciden con los patrones de ignorar.Minor style suggestion only.
website/client/src/fr/guide/usage.md (1)
86-86: Uniformiser la ponctuation française (apostrophes & tiret long)Typiquement, on utilise l’apostrophe typographique (’), et un tiret cadratin — plutôt qu’un simple
-entouré d’espaces — pour marquer l’incise.-Lorsque vous utilisez `--stdin`, les fichiers spécifiés sont effectivement ajoutés aux motifs d'inclusion. Cela signifie que le comportement normal d'inclusion et d'exclusion s'applique toujours - les fichiers spécifiés via stdin seront toujours exclus s'ils correspondent aux motifs d'exclusion. +Lorsque vous utilisez `--stdin`, les fichiers spécifiés sont effectivement ajoutés aux motifs d’inclusion. Cela signifie que le comportement normal d’inclusion et d’exclusion s’applique toujours — les fichiers spécifiés via stdin seront toujours exclus s’ils correspondent aux motifs d’exclusion.website/client/src/pt-br/guide/usage.md (1)
80-82: Remover espaço duplicado e trocar hífen por travessãoHá dois espaços após o ponto e o hífen circundado por espaços não é o mais indicado em PT-BR.
-A opção `--stdin` permite que você canalize uma lista de caminhos de arquivos para o Repomix, oferecendo máxima flexibilidade na seleção de quais arquivos compactar. Ao usar `--stdin`, os arquivos especificados são efetivamente adicionados aos padrões de inclusão. Isso significa que o comportamento normal de inclusão e exclusão ainda se aplica - arquivos especificados via stdin ainda serão excluídos se coincidirem com padrões de exclusão. +A opção `--stdin` permite que você canalize uma lista de caminhos de arquivos para o Repomix, oferecendo máxima flexibilidade na seleção de quais arquivos compactar. Ao usar `--stdin`, os arquivos especificados são efetivamente adicionados aos padrões de inclusão. Isso significa que o comportamento normal de inclusão e exclusão ainda se aplica — arquivos especificados via stdin ainda serão excluídos se coincidirem com padrões de exclusão.website/client/src/ja/guide/usage.md (1)
82-82: コード要素include/ignoreをバッククオートで強調英単語をコードとして強調すると読みやすさが向上します。
-`--stdin`で指定されたファイルは、実質的にincludeパターンに追加されます。つまり、通常のincludeおよびignoreの動作と同じで、stdinで指定したファイルもignoreパターンに一致する場合は除外されます。 +`--stdin`で指定されたファイルは、実質的に`include`パターンに追加されます。つまり、通常の`include`および`ignore`の動作と同じで、stdinで指定したファイルも`ignore`パターンに一致する場合は除外されます。
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
README.md(1 hunks)website/client/src/de/guide/usage.md(1 hunks)website/client/src/en/guide/usage.md(1 hunks)website/client/src/es/guide/usage.md(1 hunks)website/client/src/fr/guide/usage.md(1 hunks)website/client/src/hi/guide/usage.md(1 hunks)website/client/src/id/guide/usage.md(1 hunks)website/client/src/ja/guide/usage.md(1 hunks)website/client/src/ko/guide/usage.md(1 hunks)website/client/src/pt-br/guide/usage.md(1 hunks)website/client/src/vi/guide/usage.md(1 hunks)website/client/src/zh-cn/guide/usage.md(1 hunks)website/client/src/zh-tw/guide/usage.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/client/src/zh-cn/guide/usage.md
[uncategorized] ~82-~82: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：正常"地"包含
Context: ... 使用 --stdin 时，指定的文件实际上被添加到包含模式中。这意味着正常的包含和忽略行为仍然适用 - 通过 stdin 指定的文件如果匹配忽略模式仍会被排...
(wb4)
website/client/src/pt-br/guide/usage.md
[uncategorized] ~82-~82: Pontuação duplicada
Context: ...o de quais arquivos compactar. Ao usar --stdin, os arquivos especificados são ef...
(DOUBLE_PUNCTUATION_XML)
website/client/src/zh-tw/guide/usage.md
[uncategorized] ~82-~82: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：正常"地"包含
Context: ... 使用 --stdin 時，指定的文件實際上被添加到包含模式中。這意味著正常的包含和忽略行為仍然適用 - 通過 stdin 指定的文件如果匹配忽略模式仍會被排...
(wb4)
website/client/src/fr/guide/usage.md
[typographical] ~86-~86: Caractère d’apostrophe incorrect.
Context: ...rs à empaqueter. Lorsque vous utilisez --stdin, les fichiers spécifiés sont effectivem...
(APOS_INCORRECT)
[typographical] ~86-~86: Le trait d’union est employé sans espace pour former des mots, alors que le tiret est encadré par des espaces et placé entre deux mots distincts.
Context: ...sion et d'exclusion s'applique toujours - les fichiers spécifiés via stdin seront...
(TIRET)
website/client/src/es/guide/usage.md
[uncategorized] ~82-~82: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...qué archivos empaquetar. Cuando se usa --stdin, los archivos especificados se ...
(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
[uncategorized] ~82-~82: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...l de inclusión e ignorar sigue aplicando - los archivos especificados vía stdin aú...
(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Build and run (windows-latest, 20.x)
- GitHub Check: Build and run (windows-latest, 23.x)
- GitHub Check: Test (windows-latest, 23.x)
- GitHub Check: Test (macos-latest, 24.x)
- GitHub Check: Test (macos-latest, 21.x)
- GitHub Check: auto-review
🔇 Additional comments (6)
README.md (1)
258-259: Clarification is spot-on👍 Good to see the explicit note that stdin-provided files still honor ignore rules. No further issues.
website/client/src/hi/guide/usage.md (1)
125-126: Hindi wording looks correctThe added clarification is clear and technically accurate.
No language or formatting issues spotted.website/client/src/ko/guide/usage.md (1)
82-82: Korean translation reads naturallyThe clarification sentence is technically precise and idiomatically correct.
No changes needed.website/client/src/de/guide/usage.md (1)
82-82: German clarification LGTMThe sentence clearly states the rule interaction and uses correct terminology.
Nothing to adjust.website/client/src/id/guide/usage.md (1)
97-98: Clarity looks good – no issues foundThe Indonesian clarification is clear and technically accurate.
website/client/src/vi/guide/usage.md (1)
94-95: Sentence reads well – no action requiredThe Vietnamese wording correctly conveys the rule; no improvements necessary.
There was a problem hiding this comment.
Code Review
This pull request adds documentation to explain the behavior of the --stdin flag. However, there's a potential discrepancy between the documentation and the actual code implementation regarding ignore patterns. Please verify the intended behavior and ensure consistency between the documentation and the code.
|
|
||
| The `--stdin` option allows you to pipe a list of file paths to Repomix, giving you ultimate flexibility in selecting which files to pack. | ||
|
|
||
| When using `--stdin`, the specified files are effectively added to the include patterns. This means that the normal include and ignore behavior still applies - files specified via stdin will still be excluded if they match ignore patterns. |
There was a problem hiding this comment.
The documentation states that files specified via --stdin are subject to ignore patterns. However, a review of the source code (src/core/file/fileSearch.ts) suggests that --stdin bypasses ignore patterns. This discrepancy could lead to unintended inclusion of files. Please verify the intended behavior and update the documentation or code accordingly.
Summary
--stdinbehavior to README.md and all website documentationChanges
Details
When using
--stdin, users might expect that specifying files directly would bypass ignore patterns. This documentation update clarifies that:--stdinare effectively added to include patternsThis ensures users understand the consistent behavior across all file selection methods.
Test plan
🤖 Generated with Claude Code