File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -22,22 +22,45 @@ The original [Repomix](https://github.com/yamadashy/repomix) is written in JavaS
2222
2323## 🚀 3. Quick Start
2424
25- You can install Repomix using pip:
25+ ### Quick Run with uvx (Recommended)
26+
27+ The easiest way to use Repomix is with [ uvx] ( https://docs.astral.sh/uv/ ) - no installation required:
2628
2729``` bash
28- pip install repomix
30+ uvx repomix
2931```
3032
31- Then run in any project directory (using the installed script is preferred):
33+ That's it! This will pack your current directory into an AI-friendly file.
3234
35+ ** More examples:**
3336``` bash
34- repomix
37+ # Pack with JSON output
38+ uvx repomix --style json
39+
40+ # Pack a remote repository
41+ uvx repomix --remote https://github.com/username/repo
42+
43+ # Pack with specific patterns
44+ uvx repomix --include " src/**/*.py" --ignore " tests/**"
45+
46+ # Use a specific version
47+ uvx repomix@0.4.1
48+ ```
49+
50+ You can also use [ pipx] ( https://pipx.pypa.io/ ) : ` pipx run repomix `
51+
52+ ### Install with pip
53+
54+ For frequent usage, you can install Repomix globally:
55+
56+ ``` bash
57+ pip install repomix
3558```
3659
37- Alternatively, you can use :
60+ Then run in any project directory :
3861
3962``` bash
40- python -m repomix
63+ repomix
4164```
4265
4366### Docker Usage
Original file line number Diff line number Diff line change @@ -23,22 +23,45 @@ Repomix 是一个强大的工具,可以将你的整个仓库打包成一个单
2323
2424## 🚀 3. 快速开始
2525
26- 你可以使用 pip 安装 Repomix:
26+ ### 使用 uvx 快速运行(推荐)
27+
28+ 使用 Repomix 最简单的方式是通过 [ uvx] ( https://docs.astral.sh/uv/ ) - 无需安装:
2729
2830``` bash
29- pip install repomix
31+ uvx repomix
3032```
3133
32- 然后在任何项目目录下运行:
34+ 就这么简单!这将把你当前目录打包成一个 AI 友好的文件。
3335
36+ ** 更多示例:**
3437``` bash
35- repomix
38+ # 使用 JSON 输出打包
39+ uvx repomix --style json
40+
41+ # 打包远程仓库
42+ uvx repomix --remote https://github.com/username/repo
43+
44+ # 使用特定模式打包
45+ uvx repomix --include " src/**/*.py" --ignore " tests/**"
46+
47+ # 使用特定版本
48+ uvx repomix@0.4.1
49+ ```
50+
51+ 你也可以使用 [ pipx] ( https://pipx.pypa.io/ ) :` pipx run repomix `
52+
53+ ### 使用 pip 安装
54+
55+ 如果需要频繁使用,可以全局安装 Repomix:
56+
57+ ``` bash
58+ pip install repomix
3659```
3760
38- 或者,你也可以使用:
61+ 然后在任何项目目录下运行:
3962
4063``` bash
41- python -m repomix
64+ repomix
4265```
4366
4467### Docker 使用
You can’t perform that action at this time.
0 commit comments