{"id":20875958,"url":"https://github.com/saqqdy/gitmars","last_synced_at":"2025-05-12T15:31:58.102Z","repository":{"id":38009604,"uuid":"241378417","full_name":"saqqdy/gitmars","owner":"saqqdy","description":"一个 git 工作流工具","archived":false,"fork":false,"pushed_at":"2025-01-13T01:45:12.000Z","size":30264,"stargazers_count":39,"open_issues_count":20,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-01T13:01:54.702Z","etag":null,"topics":["clean-branch","git-flow","git-tool","git-ui","gitflow","gitm","gitmars","saqqdy","workflow"],"latest_commit_sha":null,"homepage":"http://www.saqqdy.com/gitmars","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saqqdy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["saqqdy"]}},"created_at":"2020-02-18T14:11:51.000Z","updated_at":"2025-01-13T01:44:28.000Z","dependencies_parsed_at":"2022-07-09T11:00:26.417Z","dependency_job_id":"5ffe9c88-eef0-47e8-a087-d56ba6dc8f41","html_url":"https://github.com/saqqdy/gitmars","commit_stats":{"total_commits":1181,"total_committers":5,"mean_commits":236.2,"dds":"0.12701100762066042","last_synced_commit":"1eafefd7fe775870afeaa85fa08b1bd8232302cb"},"previous_names":[],"tags_count":164,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saqqdy%2Fgitmars","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saqqdy%2Fgitmars/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saqqdy%2Fgitmars/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saqqdy%2Fgitmars/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saqqdy","download_url":"https://codeload.github.com/saqqdy/gitmars/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253726733,"owners_count":21954094,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-branch","git-flow","git-tool","git-ui","gitflow","gitm","gitmars","saqqdy","workflow"],"created_at":"2024-11-18T06:49:15.126Z","updated_at":"2025-05-12T15:31:56.807Z","avatar_url":"https://github.com/saqqdy.png","language":"TypeScript","funding_links":["https://github.com/sponsors/saqqdy"],"categories":[],"sub_categories":[],"readme":"\u003cdiv style=\"text-align: center;\" align=\"center\"\u003e\n\n## ![logo.png](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/logo.png)\n\n\u003c/div\u003e\n\n\u003cdiv style=\"text-align: center;\" align=\"center\"\u003e\n\n这是一个 git 工作流工具\n\n\u003c/div\u003e\n\n\u003cdiv style=\"text-align: center; margin-bottom: 20px;\" align=\"center\"\u003e\n\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![Test coverage][codecov-image]][codecov-url]\n[![npm download][download-image]][download-url]\n[![License][license-image]][license-url]\n\n[![Sonar][sonar-image]][sonar-url]\n\n\u003c/div\u003e\n\n\u003cdiv style=\"text-align: center; margin-bottom: 20px;\" align=\"center\"\u003e\n\n### **[Gitmars 使用文档](http://www.saqqdy.com/gitmars/api/)**\u0026nbsp; \u0026nbsp; \u0026nbsp; \u0026nbsp;[更新日志](http://www.saqqdy.com/gitmars/changelog.html)\n\n\u003c/div\u003e\n\n## 特性\n\n- 简单易懂的 api 设计\n- 封装了大量更易使用的 git 方法\n- 封装了大量 shell 相关方法\n\n## 使用\n\n\u003e 开始： [快速上手](http://www.saqqdy.com/gitmars/guide/getting-start.html)\u003c/br\u003e\n\u003e gitmars 配置参数：[参数说明](http://www.saqqdy.com/gitmars/guide/basic-config.html)\n\n```shell\n# 初始化\ngitm init\n\n# 查看配置\ngitm config list [option]\n\n# 版本升级[-m --mirror]使用淘宝镜像升级\nMac用户：sudo gitm upgrade -m -c npm\nWindows用户使用PowerShell或CMD：gitm upgrade latest -m -c npm.cmd\n\n# 查看版本\ngitm -v\n\n# 查看帮助信息\ngitm --help\ngitm copy --help\n```\n\n## 安装\n\n```shell\n# 通过npm安装\nnpm install -g gitmars\n\n# 或者通过yarn安装\nyarn global add gitmars\n```\n\n## 工作流展示\n\n### 1. 双主干分支发版模式\n\n![gitmars-branch.png](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/gitmars-branch.png)\n\n### 2. 单主干分支发版模式\n\n![gitmars-branch.png](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/gitmars-branch2.png)\n\n## 有哪些功能\n\n- 初始化 gitmars 配置 [gitm init](http://www.saqqdy.com/gitmars/api/#gitm-init)\n- 查看/设置 gitmars 的配置项 [gitm config](http://www.saqqdy.com/gitmars/api/#gitm-config)\n- 分支阶段提测 [gitm combine](http://www.saqqdy.com/gitmars/api/#gitm-combine)\n- 创建 bugfix 分支、创建/合并 release 分支 [gitm start](http://www.saqqdy.com/gitmars/api/#gitm-start)\n- 完成开发某项功能 [gitm end](http://www.saqqdy.com/gitmars/api/#gitm-end)\n- 更新 bug 任务分支、更新 feature 功能开发分支 [gitm update](http://www.saqqdy.com/gitmars/api/#gitm-update)\n- 分支操作 [gitm branch](http://www.saqqdy.com/gitmars/api/#gitm-branch)\n- 暂存当前分支文件 [gitm save](http://www.saqqdy.com/gitmars/api/#gitm-save)\n- 恢复暂存区最近一次暂存的文件 [gitm get](http://www.saqqdy.com/gitmars/api/#gitm-get)\n- git 操作建议 [gitm suggest](http://www.saqqdy.com/gitmars/api/#gitm-suggest)\n- 处理远程合并请求 [gitm approve](http://www.saqqdy.com/gitmars/api/#gitm-approve)\n- 远程 review 代码 [gitm review](http://www.saqqdy.com/gitmars/api/#gitm-review)\n- 清理合并过的功能分支 [gitm cleanbranch](http://www.saqqdy.com/gitmars/api/#gitm-cleanbranch)\n- 简化 git 的 cherry-pick 操作 [gitm copy](http://www.saqqdy.com/gitmars/api/#gitm-copy)\n- 继续未完成的操作 [gitm continue](http://www.saqqdy.com/gitmars/api/#gitm-continue)\n- 撤销提交 [gitm revert](http://www.saqqdy.com/gitmars/api/#gitm-revert)\n- 撤回某次提交记录或者撤回谋条分支的合并记录 [gitm undo](http://www.saqqdy.com/gitmars/api/#gitm-undo)\n- 重做某次提交记录或者重做谋条分支的合并记录 [gitm redo](http://www.saqqdy.com/gitmars/api/#gitm-redo)\n- 查看当前分支状态 [gitm status](http://www.saqqdy.com/gitmars/api/#gitm-status)\n- 升级 gitmars [gitm upgrade](http://www.saqqdy.com/gitmars/api/#gitm-upgrade)\n- 构建 Jenkins [gitm build](http://www.saqqdy.com/gitmars/api/#gitm-build)\n- 解除软链接 [gitm unlink](http://www.saqqdy.com/gitmars/api/#gitm-unlink)\n- 软链接 [gitm link](http://www.saqqdy.com/gitmars/api/#gitm-link)\n- 清除缓存 [gitm clean](http://www.saqqdy.com/gitmars/api/#gitm-clean)\n- 推送消息 [gitm postmsg](http://www.saqqdy.com/gitmars/api/#gitm-postmsg)\n- 提交权限 [gitm permission](http://www.saqqdy.com/gitmars/api/#gitm-permission)\n- git 钩子指令 [gitm hook](http://www.saqqdy.com/gitmars/api/#gitm-hook)\n- git 钩子运行指令 [gitm run](http://www.saqqdy.com/gitmars/api/#gitm-run)\n- 查询日志 [gitm log](http://www.saqqdy.com/gitmars/api/#gitm-log)\n- 智能猜测你要执行的动作 [gitm go](http://www.saqqdy.com/gitmars/api/#gitm-go)\n- 安装和移除快捷方式 [gitm alias](http://www.saqqdy.com/gitmars/api/#gitm-alias)\n- 管理员创建主干分支 [gitm admin create](http://www.saqqdy.com/gitmars/api/#gitm-admin-create)\n- 发布分支 [gitm admin publish](http://www.saqqdy.com/gitmars/api/#gitm-admin-publish)\n- 更新主干分支代码 [gitm admin update](http://www.saqqdy.com/gitmars/api/#gitm-admin-update)\n- 清理分支 [gitm admin clean](http://www.saqqdy.com/gitmars/api/#gitm-admin-clean)\n\n## 智能导航\n\n### gitm go\n\n智能导航指令，只记一条指令就能完成所有功能使用\n\n- 使用：`gitm go`\n- 参数：\n\n| 参数    | 说明     | 类型   | 可选值                                                                                                                                                                                                                      | 必填 | 默认 |\n| ------- | -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | ---- |\n| command | 指令名称 | String | combine、end、update、build、start、undo、redo、suggest、approve、review、admin.publish、admin.update、admin.create、admin.clean、admin.approve、branch、copy、get、save、cleanbranch、clean、revert、link、unlink、postmsg | 否   | -    |\n\n- 示例：\n\n```shell\ngitm go build\n```\n\n- 演示：\n\n![gitmars-go.gif](https://raw.githubusercontent.com/saqqdy/gitmars/master/static/img/gitmars-go.gif)\n\n[npm-image]: https://img.shields.io/npm/v/gitmars.svg?style=flat-square\n[npm-url]: https://npmjs.com/package/gitmars\n[travis-image]: https://travis-ci.com/saqqdy/gitmars.svg?branch=master\n[travis-url]: https://travis-ci.com/saqqdy/gitmars\n[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/gitmars.svg?style=flat-square\n[codecov-url]: https://codecov.io/github/saqqdy/gitmars?branch=master\n[download-image]: https://img.shields.io/npm/dm/gitmars.svg?style=flat-square\n[download-url]: https://npmjs.com/package/gitmars\n[license-image]: https://img.shields.io/badge/License-GPL-blue.svg\n[license-url]: LICENSE\n[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_gitmars\n[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_gitmars\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaqqdy%2Fgitmars","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaqqdy%2Fgitmars","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaqqdy%2Fgitmars/lists"}