repomix — Agent Guide

No conflict-matrix pairs for this tool yet.

# Repomix — Agent Guide

name: repomix ｜ version_range: 1.18.0~1.18.0 ｜ generated: 2026-08-29

title_en: Repomix - Pack a Repository into a Single Token-Controlled File ｜ desc_en: Packs an entire repository into a single file with a controlled token budget for AI analysis.

Preflight

note: Requires Node >= 18 for npm/npx forms; standalone binary form not tested.

node --version

预期输出: see command output

Install

note: npmmirror registry prefix required in mainland China (verified instant install). No-install form: npx -y repomix.

npm_config_registry=https://registry.npmmirror.com npm install -g repomix
repomix --version

预期输出: 1.18.0

Operations

Pack the repository into a single file

note: Run inside the target repository root; output written to current directory (default repomix-output.txt) - add it to .gitignore.

repomix . --compress --output repomix-output.txt

预期输出: Pack Summary (Total Files / Total Tokens / Output path; verified 2026-08-29: 2 files → 1983 chars)

Control packing scope and token budget

note: --compress verified; --include is an official feature, not tested.

repomix . --compress --include "src/**/*.ts,README.md"

预期输出: only matching files are packed

Specify the output path

note: Verified on 2026-08-29.

repomix . --output /tmp/repo-context.txt

预期输出: single file written to the specified path

Uninstall

note: npm global uninstall; leftovers = output file and optional workspace repomix.config.json (manual).

npm uninstall -g repomix
command -v repomix >/dev/null 2>&1 && echo "残留: repomix 仍存在" || echo "repomix removed: OK"

预期输出: repomix removed: OK

Facts

writes: repomix-output.txt (current dir), optional workspace repomix.config.json ｜ runtime: Node.js (npm/npx form), no background process ｜ notes: no user-level config writes; reads optional global config under ~/.config/repomix/; --init write surface and standalone binary not tested.

Source: repomix · validated 2026-08-29 · v1.18.0~1.18.0

← Agent index