#text-file #ai #utility #command-line-tool #cli

应用 repo2file-cli

一个用Rust编写的超级快速的命令行工具,可以将代码仓库转换为单个文本文件

3个版本

0.1.2 2024年7月25日
0.1.1 2024年6月5日
0.1.0 2024年6月5日

843命令行工具

Download history 223/week @ 2024-06-01 21/week @ 2024-06-08 3/week @ 2024-06-15 105/week @ 2024-07-20 29/week @ 2024-07-27

134 每月下载量

MIT 许可证

18KB
342

repo2file-cli

repo2file-cli 是一个命令行工具,用于将代码仓库合并为单个文本文件。这对于归档、分析或共享目的很有用。

安装

要安装 repo2file-cli,您需要已安装Rust。如果您还没有安装Rust,可以从 rustup.rs 获取。

一旦您有了Rust,您可以使用 cargo 安装 repo2file-cli

cargo install repo2file-cli

用法

要使用 repo2file-cli,您可以运行以下命令

repo2file-cli <input> [OPTIONS]

参数

  • <input>:您要处理的仓库的目录或Git URL。

选项

  • --ignore-files <FILES>:要忽略的文件的逗号分隔列表。
  • --ignore-dirs <DIRS>:要忽略的目录的逗号分隔列表。
  • --include-files <FILES>:要唯一包含的文件的逗号分隔列表(不能与 --ignore-files--ignore-dirs 一起使用)。
  • --output <OUTPUT>:输出文件。默认为当前目录命名的文件。

示例

转换本地仓库

repo2file-cli /path/to/repository --output output.txt

转换GitHub仓库

repo2file-cli https://github.com/username/repo --output output.txt

忽略特定的文件和目录

repo2file-cli /path/to/repository --ignore-files *.md,*.json --ignore-dirs node_modules,.git

只包含特定的文件

repo2file-cli /path/to/repository --include-files *.rs,*.toml

贡献

我们欢迎贡献!请按照以下步骤进行贡献

  1. 将仓库进行Fork。
  2. 创建一个新的分支(git checkout -b feature-branch)。
  3. 进行您的更改。
  4. 提交您的更改(git commit -am 'Add new feature')。
  5. 将代码推送到分支(git push origin feature-branch)。
  6. 创建一个新的拉取请求。

开发设置

要设置您的开发环境,请按照以下步骤操作

  1. 克隆仓库
    git clone https://github.com/yourusername/repo2file-cli.git
    
  2. 切换到项目目录
    cd repo2file-cli
    
  3. 安装所需的扩展(如果使用VSCode)

运行测试

您可以使用以下命令运行测试

cargo test

从源构建

在开发过程中,您可以安装二进制文件

cargo install --path .

许可协议

该项目受MIT许可协议的许可 - 有关详细信息,请参阅LICENSE文件。

依赖项

~14–24MB
~404K SLoC