README
🚀 GIT MCP 使用文档
GIT MCP 是一款强大的 Git 仓库管理与操作工具。它提供了丰富多样的命令集,能帮助开发者高效地进行版本控制,提升开发效率。
🚀 快速开始
GIT MCP 可助力开发者高效开展版本控制工作。下面为你介绍其基本使用方法,助你快速上手。
✨ 主要特性
功能特点
- 代码库管理:支持创建、克隆、删除和管理多个代码库
- 分支操作:提供创建、切换、合并和删除分支的功能
- 远程仓库交互:与 GitHub、GitLab 等远程仓库进行高效协作
- 标签管理:支持创建、列出和删除代码库中的标签
- 提交历史:显示完整的提交记录,包括作者信息、提交时间及提交说明
- 文件查看:在指定版本或分支下查看具体文件的内容
- 差异分析:对比不同版本之间的代码变化
常用命令
仓库管理
| 命令 | 描述 |
|--------------------------|----------------------------------------|
| git-mcp init | 初始化一个新的 Git 仓库 |
| git-mcp clone [url] | 克隆一个远程仓库到本地 |
| git-mcp add [file-path] | 将指定文件添加到版本控制中 |
| git-mcp rm [file-path] | 移除指定文件的版本控制 |
| git-mcp clean | 删除工作目录下未被跟踪的文件 |
提交操作
| 命令 | 描述 |
|--------------------|----------------------------------------|
| git-mcp status | 查看当前仓库的状态 |
| git-mcp commit | 提交 staged 变化 |
| git-mcp push | 将本地提交推送到远程仓库 |
| git-mcp pull | 从远程仓库拉取最新更新 |
分支管理
| 命令 | 描述 |
|--------------------|----------------------------------------|
| git-mcp branch | 查看所有分支 |
| git-mcp checkout | 切换到指定分支 |
| git-mcp merge | 合并指定分支到当前分支 |
📚 详细文档
GIT MCP 资源
MCP 提供以下资源来帮助开发者操作 Git:
帮助文档
- 使用手册:提供详细的命令说明和使用指南
- API 文档:介绍 MCP 的 API 接口及其使用方法
示例代码库
- 在
examples文件夹中,包含多个演示项目,涵盖不同的使用场景。
开发指南
本地开发
| 脚本命令 | 描述 |
|------------------|--------------------|
| npm install | 安装 MCP 依赖项 |
| npm run build | 构建 MCP 工具 |
贡献指南
- 代码规范:遵循项目中的
.stylelintrc文件要求 - 测试要求:在提交前运行单元测试,确保通过所有检查
- 提交规范:
- 提交信息需包含类型和作用域,例如
feat: 新增功能 - 提交说明需简洁明了
- 提交信息需包含类型和作用域,例如
📄 许可证
MCP 是开源软件,遵循 MIT 许可证。查看 LICENSE 文件以获取详细信息。
如需进一步了解,请参考官方文档或加入开发者社区进行交流。
微信扫一扫