Skip to content

Latest commit

 

History

History
231 lines (156 loc) · 4.72 KB

README.md

File metadata and controls

231 lines (156 loc) · 4.72 KB
Raw

mgit logo

MGIT - git 多仓库管理工具

mgit

mgit 是一个用 rust 编写的 git 多仓库管理工具。 他的主要功能有：

  • 一键生成当前文件夹下所有仓库的管理配置文件
  • 根据配置文件内容，更新指定仓库的 branch，tag 或 commit
  • 根据配置文件内容，清理文件夹下的无用仓库
  • 提供 cli 工具和 gui 工具

命令行工具 (CLI)

Usage: mgit.exe <COMMAND>

Commands:
  init      Init git repos
  snapshot  Snapshot git repos
  sync      Sync git repos
  fetch     Fetch git repos
  clean     Clean unused git repos
  track     Track remote branch
  ls-files  List files
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help information
  -V, --version  Print version information

init

mgit init [OPTIONS] [PATH]

初始化指定目录，扫描目录夹下的 git 仓库，并生成配置文件 .gitrepos

Options

  • --force 强制执行并覆盖已有的 .gitrepos

snapshot

mgit snapshot [OPTIONS] [PATH]

快照指定目录，扫描目录夹下的 git 仓库，并将当前 commit 记录生成配置文件

Options

  • --config <FILE> 指定配置文件，默认找当前目录下的 .gitrepos
  • --branch 生成 branch 快照
  • --force 强制执行并覆盖已有的配置文件
  • --ignore 忽略不想生成 config 文件的目录，可多次使用

sync

mgit sync [OPTIONS] [PATH]

通过配置文件，拉取更新仓库。

Options

  • --config <FILE> 指定配置文件，默认找当前目录下的 .gitrepos
  • -t, --thread <NUMBER> 设置线程数量，默认是 4
  • --silent 在 sync 中启用静默播报模式
  • --no-track 在 sync 后不跟踪远端分支
  • --no-checkout 在 sync 后不迁出新的远端分支
  • --stash 在 sync 前暂存本地改动
  • --hard 在 sync 前忽略所有本地改动
  • --ignore 忽略不想生成 config 文件的目录，可多次使用
  • --depth 设置 sync 的深度

Sparse checkout 通过配置文件添加 sparse 字段支持

[[repos]]
sparse = ["Doc", "/*.md"]

fetch

mgit fetch [OPTIONS] [PATH]

对指定目录执行 git fetch 指令

Options

  • --config <FILE> 指定配置文件，默认找当前目录下的 .gitrepos
  • -t, --thread <NUMBER> 设置线程数量，默认是 4
  • --silent 在 sync 中启用静默播报模式
  • --ignore 忽略不想生成 config 文件的目录，可多次使用
  • --depth 设置 fetch 深度

clean

mgit clean [OPTIONS] [PATH]

根据配置文件的仓库路径和指定路径的仓库之间的比对结果，清理不在配置文件中的仓库。

Options

  • --config <FILE> 指定配置文件，默认找当前目录下的 .gitrepos

track

mgit track [OPTIONS] [PATH]

通过配置文件，跟踪远端分支

Options

  • --config <FILE> 指定配置文件，默认找当前目录下的 .gitrepos
  • --ignore 忽略不想生成 config 文件的目录，可多次使用

ls-files

mgit ls-files [OPTIONS] [PATH]

通过配置文件，浏览本地文件

Options

  • --config <FILE> 指定配置文件，默认找当前目录下的 .gitrepos

图形界面工具 (GUI)

  • 提供勾选界面，方便管理仓库
  • 提供菜单选项
  • 根据项目保存用户配置
  • ...

构建

从源码编译

Linux

  1. 安装依赖
sudo apt update
sudo apt-get install -y \
    gcc g++ \
    cmake pkg-config \
    fontconfig \
    libgtk-3-dev
  1. 使用 cargo 构建
cargo build [--release]

测试

使用Docker自建本地gitea服务器

1. 环境准备

  • 确保已经正确安装Docker
  • 确保已经正确安装curl、git、jq
# 位于项目根目录下执行
gitea_compose/start_gitea.sh

Windows 下请使用 wsl2

2. 运行测试

cargo test --features=use_gitea

3. 基准

time cargo test --features=use_gitea

# cargo test  5.83s user 1.99s system 188% cpu 4.136 total

使用常规测试

1. 环境准备

# do nothing

2. 运行测试

cargo test

3. 基准

time cargo test

# cargo test  12.66s user 4.37s system 60% cpu 28.380 total

参考