# gitmars **Repository Path**: hunshikan/gitmars ## Basic Information - **Project Name**: gitmars - **Description**: 一个高度定制化的git工作流工具 - **Primary Language**: JavaScript - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 3 - **Created**: 2021-10-25 - **Last Updated**: 2022-05-25 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ![logo.png](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/logo.png) [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Test coverage][codecov-image]][codecov-url] [![David deps][david-image]][david-url] [![Known Vulnerabilities][snyk-image]][snyk-url] [![npm download][download-image]][download-url] [![License][license-image]][license-url] [![Sonar][sonar-image]][sonar-url] [npm-image]: https://img.shields.io/npm/v/gitmars.svg?style=flat-square [npm-url]: https://npmjs.org/package/gitmars [travis-image]: https://travis-ci.com/saqqdy/gitmars.svg?branch=master [travis-url]: https://travis-ci.com/saqqdy/gitmars [codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/gitmars.svg?style=flat-square [codecov-url]: https://codecov.io/github/saqqdy/gitmars?branch=master [david-image]: https://img.shields.io/david/saqqdy/gitmars.svg?style=flat-square [david-url]: https://david-dm.org/saqqdy/gitmars [snyk-image]: https://snyk.io/test/npm/gitmars/badge.svg?style=flat-square [snyk-url]: https://snyk.io/test/npm/gitmars [download-image]: https://img.shields.io/npm/dm/gitmars.svg?style=flat-square [download-url]: https://npmjs.org/package/gitmars [license-image]: https://img.shields.io/badge/License-MIT-yellow.svg [license-url]: LICENSE [sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_gitmars [sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_gitmars # Gitmars: 一个定制化的`git`工作流操作工具 > 1. gitmars 每一个子命令都带了`help`功能，可输入`gitm [command] --help`获取对应指令的帮助 > 2. ``意思是 type 必传；`[type]`意思是 type 选填；`[-a --app [app]]`其中-a 是--app 的简写，后面`[app]`指的是-a 后面的传值 # **完整文档请查阅： [Gitmars 使用文档](http://www.saqqdy.com/gitmars/api/)** > 更新日志请查阅：[Gitmars 更新日志](http://www.saqqdy.com/gitmars/changelog.html) # 安装 > Windows 用户需要先安装`Python` ```shell # 通过npm安装 npm install -g gitmars # 或者通过yarn安装 yarn global add gitmars # 不想安装Python环境且不想用gitm ui，可安装lite版本，lite版本有最新版除UI之外的所有功能 npm install -g gitmars@lite ``` # 使用 > 开始： [快速上手](http://www.saqqdy.com/gitmars/guide/getting-start.html) > gitmars 配置参数：[参数说明](http://www.saqqdy.com/gitmars/guide/basic-config.html) ```shell # 初始化 gitm init # 查看配置 gitm config list [option] # 版本升级[-m --mirror]使用淘宝镜像升级 Mac用户：sudo gitm upgrade -m windows用户：npm i -g gitmars@lite # 查看版本 gitm -v # 查看帮助信息 gitm --help gitm copy --help ``` # 工作流展示 ![gitmars-branch.png](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/gitmars-branch.png) # 有哪些功能 - 初始化 gitmars 配置 [gitm init](http://www.saqqdy.com/gitmars/api/#gitm-init) - 查看/设置 gitmars 的配置项 [gitm config](http://www.saqqdy.com/gitmars/api/#gitm-config) - 分支阶段提测 [gitm combine](http://www.saqqdy.com/gitmars/api/#gitm-combine) - 创建 bugfix 分支、创建/合并 release 分支 [gitm start](http://www.saqqdy.com/gitmars/api/#gitm-start) - 完成开发某项功能 [gitm end](http://www.saqqdy.com/gitmars/api/#gitm-end) - 更新 bug 任务分支、更新 feature 功能开发分支 [gitm update](http://www.saqqdy.com/gitmars/api/#gitm-update) - 分支操作 [gitm branch](http://www.saqqdy.com/gitmars/api/#gitm-branch) - 暂存当前分支文件 [gitm save](http://www.saqqdy.com/gitmars/api/#gitm-save) - 恢复暂存区最近一次暂存的文件 [gitm get](http://www.saqqdy.com/gitmars/api/#gitm-get) - 简化 git 的 cherry-pick 操作 [gitm copy](http://www.saqqdy.com/gitmars/api/#gitm-copy) - 合并代码 [gitm merge](http://www.saqqdy.com/gitmars/api/#gitm-merge) - 继续未完成的操作 [gitm continue](http://www.saqqdy.com/gitmars/api/#gitm-continue) - 撤销提交 [gitm revert](http://www.saqqdy.com/gitmars/api/#gitm-revert) - 撤回某次提交记录或者撤回谋条分支的合并记录 [gitm undo](http://www.saqqdy.com/gitmars/api/#gitm-undo) - 重做某次提交记录或者重做谋条分支的合并记录 [gitm redo](http://www.saqqdy.com/gitmars/api/#gitm-redo) - 升级 gitmars [gitm upgrade](http://www.saqqdy.com/gitmars/api/#gitm-upgrade) - 构建 Jenkins [gitm build](http://www.saqqdy.com/gitmars/api/#gitm-build) - 解除软链接 [gitm unlink](http://www.saqqdy.com/gitmars/api/#gitm-unlink) - 软链接 [gitm link](http://www.saqqdy.com/gitmars/api/#gitm-link) - 清除缓存 [gitm clean](http://www.saqqdy.com/gitmars/api/#gitm-clean) - 推送云之家消息 [gitm postmsg](http://www.saqqdy.com/gitmars/api/#gitm-postmsg) - 提交权限 [gitm permission](http://www.saqqdy.com/gitmars/api/#gitm-permission) - git 钩子指令 [gitm hook](http://www.saqqdy.com/gitmars/api/#gitm-hook) - git 钩子运行指令 [gitm run](http://www.saqqdy.com/gitmars/api/#gitm-run) - 查询日志 [gitm log](http://www.saqqdy.com/gitmars/api/#gitm-log) - 智能猜测你要执行的动作 [gitm go](http://www.saqqdy.com/gitmars/api/#gitm-go) - UI 可视化操作 [gitm ui](http://www.saqqdy.com/gitmars/api/#gitm-ui) - 管理员创建主干分支 [gitm admin create](http://www.saqqdy.com/gitmars/api/#gitm-admin-create) - 发布分支 [gitm admin publish](http://www.saqqdy.com/gitmars/api/#gitm-admin-publish) - 更新主干分支代码 [gitm admin update](http://www.saqqdy.com/gitmars/api/#gitm-admin-update) - 清理分支 [gitm admin clean](http://www.saqqdy.com/gitmars/api/#gitm-admin-clean) - 查看版本号 [gitm version](http://www.saqqdy.com/gitmars/api/#gitm-version) # 智能导航 ## gitm go 智能导航指令，只记一条指令就能完成所有功能使用 - 使用：`gitm go` - 参数： | 参数 | 说明 | 类型 | 可选值 | 必填 | 默认 | | ------- | -------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | ---- | | command | 指令名称 | String | combine、end、update、build、start、admin.publish、admin.update、admin.create、admin.clean、branch、copy、get、save、revert、link、unlink、postmsg | 否 | - | - 示例： ```shell gitm go build ``` - 演示： ![gitmars-go.gif](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/gitmars-go.gif) # UI 界面 ## gitm ui 如果你厌倦了敲指令，gitmars 提供了懒人 UI 界面 - 使用：`gitm ui` - 传值： | 名称 | 简写 | 说明 | 类型 | 可选值 | 传值必填 | 默认 | | ------ | ---- | ---------- | ------ | ------ | -------- | ---- | | --port | -p | 启动端口号 | Number | - | 否 | 3000 | - 示例： ```shell gitm ui --port 3000 ``` - 演示： ![gitmars-ui.gif](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/gitmars-ui.gif)