From c0bda858899e152e863b9e084529f5ffd955da9a Mon Sep 17 00:00:00 2001 From: Kazuki Yamada Date: Fri, 12 Sep 2025 20:31:08 +0900 Subject: [PATCH 1/4] docs(cli): Improve help text clarity and accuracy Update CLI option descriptions to be more clear and self-explanatory, making them easier for users to understand without consulting external documentation. Key changes include: - Fix default values to match actual implementation (xml format, repomix-output.xml filename) - Clarify actual behavior vs. stated behavior (e.g., stdin file processing, stdout logging suppression) - Remove misleading claims about token reduction percentages - Add missing default values and examples - Improve technical descriptions to be more accessible - Make option purposes and use cases clearer This addresses user feedback about confusing CLI help text and ensures descriptions accurately reflect the code implementation. --- README.md | 76 +++++++++++++++++++++++------------------------ src/cli/cliRun.ts | 76 +++++++++++++++++++++++------------------------ 2 files changed, 76 insertions(+), 76 deletions(-) diff --git a/README.md b/README.md index 8c16075ef..35d26a134 100644 --- a/README.md +++ b/README.md @@ -531,60 +531,60 @@ Instruction ### Command Line Options #### Basic Options -- `-v, --version`: Show tool version +- `-v, --version`: Show version information and exit #### CLI Input/Output Options -- `--verbose`: Enable verbose logging -- `--quiet`: Disable all output to stdout -- `--stdout`: Output to stdout instead of writing to a file (cannot be used with `--output` option) -- `--stdin`: Read file paths from stdin instead of discovering files automatically -- `--copy`: Additionally copy generated output to system clipboard -- `--token-count-tree [threshold]`: Display file tree with token count summaries (optional: minimum token count threshold). Useful for identifying large files and optimizing token usage for AI context limits -- `--top-files-len `: Number of top files to display in the summary +- `--verbose`: Enable detailed debug logging (shows file processing, token counts, and configuration details) +- `--quiet`: Suppress all console output except errors (useful for scripting) +- `--stdout`: Write packed output directly to stdout instead of a file (suppresses all logging) +- `--stdin`: Read file paths from stdin, one per line (specified files are processed directly) +- `--copy`: Copy the generated output to system clipboard after processing +- `--token-count-tree [threshold]`: Show file tree with token counts; optional threshold to show only files with ≥N tokens (e.g., --token-count-tree 100) +- `--top-files-len `: Number of largest files to show in summary (default: 5, e.g., --top-files-len 20) #### Repomix Output Options -- `-o, --output `: Specify the output file name -- `--style