# gitmm

**Repository Path**: Bolehu/gitmm

## Basic Information

- **Project Name**: gitmm
- **Description**: 批量操作git仓库的工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2023-10-29
- **Last Updated**: 2023-10-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用说明

> 集成一些批量操作git仓库的工具

## 安装卸载方法

### 编译

```shell
make clean build_win install_win build_linux package
# release
make clean build_win install_win build_linux package release BUILD_MODE=release BUILD_VERSION=1.1.0
```

### 安装

编译后，复制`gitmm.exe`到`C:\Windows`目录下即可全局使用。或者

```shell
make clean build_win install_win
```

### 卸载

删除`C:\Windows\gitmm.exe`即可。

## 环境要求

git > 2.28.0

## 仓库访问方式说明

### ssh方式（推荐）

使用ssh方式访问仓库请配置ssh私钥到代码托管平台。

```shell
# 生成密钥对，执行ssh-keygen命令，一路回车
ssh-keygen
# 查看生成的公钥信息，这个公钥就是需要配置到平台上的内容
cat ~/.ssh/id_rsa.pub

# 也可以自定义公钥
# 自定义公钥的配置方式请参考ssh客户端配置在 ~/.ssh/config 文件中配置，示例如下
Host gitee.com
    HostName gitee.com
    IdentityFile ~/.ssh/kehao@kehaopc
    User git

Host *
    IdentitiesOnly yes
    AddressFamily inet
    Protocol 2
    Compression yes
    ServerAliveInterval 60
    ServerAliveCountMax 20
    HostkeyAlgorithms +ssh-rsa
    PubkeyAcceptedKeyTypes +ssh-rsa

```

配置ssh私钥到代码托管平台的方法各有差异，请查阅托管平台配置项。

### http/https方式

使用http/https方式访问仓库请配置认证信息持久化存储。

配置方法

```shell
git config --global credential.helper store
```

## 配置文件说明

配置文件 `repo.yaml` 用来配置主从仓库上游信息，示例内容如下：

```yaml
remote:
  # upstream from
  upstream: 'git@gitee.com:chmodke'
  # origin to
  origin: 'ssh://git@192.168.100.100:2222/chmodke'
# repos repository list
repos:
  - arpc
  - ftrans
  - gitmm
```

- upstream : 主仓库上游地址
- origin : 从仓库(fork)上游地址
- repos : 仓库名称列表

<font style="color:red">注意：`upstream` ：是主仓库上游地址，`origin` 是从仓库上游地址，一定不能配反了。</font>

## 子命令说明

> 所有子命令都支持`-h`或`--help` 参数查看帮助。

```shell
Usage:
  gitmm [command]

Available Commands:
  batch       批量执行提供的git命令
  clone       批量克隆仓库
  completion  Generate the autocompletion script for the specified shell
  config      生成示例配置文件，校验配置文件
  create      批量创建分支
  help        Help about any command
  list        展示工作路径下的Git仓库信息
  pull        批量拉取仓库
  remote      批量查看仓库远程信息
  switch      批量切换分支
  sync        批量同步主从仓库
  version     Show tool version

Flags:
  -h, --help           help for gitmm
  -v, --version        show tool version.

Use "gitmm [command] --help" for more information about a command.
```

### config

> 生成示例配置文件

用于在当前目录下生成示例配置文件，校验当前目录下的配置文件

#### 执行格式

```shell
Usage:
  gitmm config [flags]
  gitmm config [command]

Available Commands:
  generate    生成示例配置文件
  verify      校验配置文件

Flags:
  -h, --help   help for config

# 示例，校验配置文件
gitmm config verify
```

#### 参数

- 无参数

### list

> 遍历展示仓库最新提交记录

执行命令会遍历`work_dir`目录下中的git仓库，展示仓库最新提交记录。

#### 执行格式

```shell
Usage:
  gitmm list [flags]

Examples:
gitmm list -w tmp

Flags:
  -h, --help                  help for list
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -n, --line-number int       日志行数 (default 1)
  -m, --match string          仓库过滤条件，golang正则表达式
  -w, --work_dir string       本地代码的存放路径 (default ".")

```

### clone

> 批量克隆仓库

执行命令会读取当前目录下`repo.yaml`配置文件，遍历`repos`配置项，从`origin`克隆代码到当前目录下`work_dir`指定的文件夹中。

#### 执行格式

```shell
Usage:
  gitmm clone [flags]

Examples:
gitmm clone -w tmp -b master

Flags:
  -h, --help                  help for clone
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -m, --match string          仓库过滤条件，golang正则表达式
  -u, --remote string         克隆代码的远程名称 (default "origin")
  -b, --work_branch string    克隆代码的分支 (default "master")
  -w, --work_dir string       克隆代码的存放路径 (default "master")

# 示例：下面将克隆仓库的master分支到本地tmp目录中
gitmm clone -w tmp -b master
```

#### 参数

- work_dir: 可选项，克隆代码的存放路径
- work_branch: 可选项，克隆代码的分支，缺省值`master`
- remote: 可选项，克隆代码的远程名称，缺省值`origin`
- match: 可选项，仓库过滤条件，golang正则表达式，优先级高于`invert-match`
- invert-match: 可选项，仓库反向过滤条件，golang正则表达式

### sync

> 批量同步主从仓库

执行命令会读取当前目录下`repo.yaml`配置文件，遍历`repos`配置项，从`upstream`强制同步全部内容到`origin`
中，需要用户对`origin`有强制写权限（取消分支保护）。

<font style="color:red">注意：会强制以 `upstream` 中的内容覆盖 `origin` 中的内容。</font>

#### 执行格式

```shell
Usage:
  gitmm sync [flags]

Examples:
gitmm sync

Flags:
  -h, --help                  help for sync
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -m, --match string          仓库过滤条件，golang正则表达式

```

#### 参数

- match: 可选项，仓库过滤条件，golang正则表达式，优先级高于`invert-match`
- invert-match: 可选项，仓库反向过滤条件，golang正则表达式

### pull

> 批量拉取仓库

执行命令会遍历`work_dir`目录下中的git仓库，并执行分支拉取操作。

#### 执行格式

```shell
Usage:
  gitmm pull [flags]

Examples:
gitmm pull -w tmp

Flags:
  -f, --force                 强制拉取
  -h, --help                  help for pull
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -m, --match string          仓库过滤条件，golang正则表达式
  -w, --work_dir string       本地代码的存放路径 (default ".")

# 示例：下面拉取当前目录下tmp文件夹中所有仓库的最新代码
gitmm pull -w tmp
```

#### 参数

- work_dir: 可选项，仓库的存放路径，默认值当前目录
- force: 可选项，强制拉取，强制拉取时会回退本地所有修改到远程的最新记录
- match: 可选项，仓库过滤条件，golang正则表达式，优先级高于`invert-match`
- invert-match: 可选项，仓库反向过滤条件，golang正则表达式

### create

> 批量创建分支

执行命令会遍历`work_dir`中的git仓库，并执行分支创建操作。

#### 执行格式

```shell
Usage:
  gitmm create [flags]

Examples:
git create -w tmp -b develop

Flags:
  -h, --help                  help for create
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -m, --match string          仓库过滤条件，golang正则表达式
  -b, --new_branch string     新分支名称 (default "master")
  -r, --refs string           新分支起点 (default "HEAD")
  -w, --work_dir string       本地代码的存放路径 (default ".")

# 示例：下面将对当前目录下tmp文件夹中所有仓库基于当前节点创建develop分支
gitmm create -w tmp -b develop
```

#### 参数

- work_dir: 可选项，仓库的存放路径，默认值当前目录
- new_branch: 必填项，新分支名称
- start_point: 可选项，分支起始点，默认`HEAD`
- match: 可选项，仓库过滤条件，golang正则表达式，优先级高于`invert-match`
- invert-match: 可选项，仓库反向过滤条件，golang正则表达式

### switch

> 批量切换分支

执行命令会遍历`work_dir`中的git仓库，并执行分支切换操作。

#### 执行格式

```shell
Usage:
  gitmm switch [flags]

Examples:
gitmm switch -w tmp -b develop

Flags:
  -b, --branch string         目标分支/tag/commit (default "master")
  -f, --force                 强制切换
  -h, --help                  help for switch
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -m, --match string          仓库过滤条件，golang正则表达式
  -w, --work_dir string       本地代码的存放路径 (default ".")

# 示例：下面将切换当前目录下tmp文件夹中所有仓库到develop分支
gitmm switch -w tmp -b develop
```

#### 参数

- work_dir: 可选项，仓库的存放路径，默认值当前目录
- branch: 必填项，目标分支名称
- force: 可选项，强制切换，强制切换时会回退本地所有修改
- match: 可选项，仓库过滤条件，golang正则表达式，优先级高于`invert-match`
- invert-match: 可选项，仓库反向过滤条件，golang正则表达式

### remote

> 批量查看仓库远程信息

执行命令会遍历`work_dir`目录下中的git仓库，并查看仓库远程信息。

#### 执行格式

```shell
Usage:
  gitmm remote [flags]

Examples:
gitmm remote -w tmp

Flags:
  -h, --help                  help for remote
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -m, --match string          仓库过滤条件，golang正则表达式
  -w, --work_dir string       本地代码的存放路径 (default ".")

# 示例：下面将查看当前目录下master文件夹中所有仓库的远程信息
gitmm remote -w tmp
```

#### 参数

- work_dir: 可选项，仓库的存放路径，默认值当前目录
- match: 可选项，仓库过滤条件，golang正则表达式，优先级高于`invert-match`
- invert-match: 可选项，仓库反向过滤条件，golang正则表达式

### batch

> 批量执行提供的git命令

执行命令会遍历`work_dir`中的git仓库，并执行提供的git命令。

#### 执行格式

```shell
Usage:
  gitmm batch [flags]

Examples:
gitmm batch -w tmp 'log --oneline -n1'

Flags:
  -h, --help                  help for batch
  -i, --invert-match string   仓库反向过滤条件，golang正则表达式
  -m, --match string          仓库过滤条件，golang正则表达式
  -w, --work_dir string       本地代码的存放路径 (default ".")

# 示例：下面将查看当前目录下tmp文件夹中所有仓库最新一条提交记录
gitmm batch -w tmp 'log --oneline -n1'
```

#### 参数

- work_dir: 可选项，仓库的存放路径，默认值当前目录
- match: 可选项，仓库过滤条件，golang正则表达式，优先级高于`invert-match`
- invert-match: 可选项，仓库反向过滤条件，golang正则表达式
- command: 必填项，git命令