Gissy：一个使用AI增强Git工作流程的命令行助手

Gissy是一个开源的命令行工具，旨在成为开发者的个人Git助手，它通过自动化重复性的Git任务来简化工作流程。该工具的核心功能是利用人工智能（AI）技术，特别是通过集成OpenAI、Google Gemini和Addis AI等多种AI服务商，来自动生成有意义的、符合规范的Git提交信息。Gissy提供了一个智能文件监视器，可以自动检测代码仓库中的文件变动，并触发一系列预设的质量检查流程，如运行测试和代码规范检查。完成检查后，它可以自动完成暂存、提交乃至推送到远程仓库的整个过程。该工具使用JavaScript构建，支持跨平台（Windows, macOS, Linux）运行，并且无需复杂配置即可开箱即用，同时也提供了丰富的配置选项，让开发者可以根据项目需求进行深度定制。

Funktionsliste

• 智能文件监视器: 自动监控代码仓库中的文件变化，触发后续的自动化流程。
• 多AI服务商支持: 集成OpenAI、Google Gemini和Addis AI，可根据用户的API密钥配置自动选择并生成高质量的Git提交信息。
• Automatisierte Arbeitsabläufe: 能够自动运行测试、执行代码规范检查、暂存文件、提交更改，并最终将代码推送到远程仓库。
• SSH密钥自动配置: 提供命令一键生成SSH密钥并自动配置到用户的GitHub账户，简化首次代码推送前的准备工作。
• Hochgradig konfigurierbar: 项目可以通过根目录下的.gissyrc.json文件进行详细配置，例如指定目标分支、是否启用测试、推送和AI功能等。
• sofort einsatzbereit: 在没有配置文件的情况下，Gissy也能以一套合理的默认设置正常工作，降低了初次使用的门槛。
• 增强的Git命令: 提供了信息更丰富、输出更美观的Git命令替代品，如gissy status, gissy infoim Gesang antwortengissy branch.
• Plattformübergreifende Kompatibilität: 基于Node.js开发，确保在Windows、macOS和Linux等主流操作系统上都能正常运行。

Hilfe verwenden

Gissy是一个功能强大的命令行工具，旨在通过自动化和AI技术简化您的Git工作流程。下面将详细介绍如何安装、配置和使用它。

Montage

Gissy基于Node.js环境，因此请确保您的电脑已安装Node.js和npm。

1. 全局安装 (推荐)
为了在任何项目中都能方便地使用gissy命令，推荐进行全局安装。打开您的终端或命令行工具，输入以下命令：

npm install -g gissy

安装完成后，您就可以在任何路径下直接使用gissy命令了。

2. 使用npx (无需安装)
如果您不想在本地安装Gissy，也可以使用npx来直接运行它。npx是npm自带的包运行器，它会临时下载并执行指定的包，不会在您的系统中留下任何文件。

# 例如，使用npx运行status命令
npx gissy status
# 使用npx启动文件监视器
npx gissy watch

Grundlegende Konfiguration

虽然Gissy开箱即用，但通过简单的配置可以让它更好地适应您的项目需求。

在您的项目根目录下创建一个名为.gissyrc.json的文件，并根据需要添加以下配置项：

{
"branch": "main",
"runTests": true,
"runLint": true,
"useAI": false,
"autoCommit": false,
"autoPush": false,
"testCommand": "npm test",
"lintCommand": "npm run lint",
"watchIgnore": [
"*.tmp",
"build/**",
"dist/**",
"node_modules/**",
".git/**",
"*.log"
]
}

配置项说明：

• branch: 指定代码推送的目标分支，默认为"main".
• runTests: 是否在提交前运行测试，默认为true.
• runLint: 是否在提交前运行代码规范检查，默认为true.
• useAI: 是否使用AI生成提交信息，默认为false.
• autoCommit: 是否跳过提交前的确认环节，默认为false.
• autoPush: 是否跳过推送前的确认环节，默认为false.
• testCommand: 定义运行测试的具体命令，默认为"npm test".
• lintCommand: 定义运行代码规范检查的命令，默认为"npm run lint".
• watchIgnore: 定义文件监视器需要忽略的文件或目录模式。

AI服务商配置

Gissy最强大的功能之一是AI自动生成提交信息。要启用此功能，您需要配置AI服务商的API密钥。

1. 在项目根目录下创建一个名为.envdes Dokuments.
2. 根据您拥有的API密钥，添加相应的环境变量：

# OpenAI API密钥 (默认优先使用)
OPENAI_API_KEY=your_openai_api_key_here
# Google Gemini API密钥
GEMINI_API_KEY=your_gemini_api_key_here
# Addis AI API密钥 (支持本地语言)
ADDIS_AI_API_KEY=your_addis_ai_api_key_here

Gissy会按照OpenAI > Google Gemini > Addis AI的优先级顺序自动检测并使用可用的API密钥。如果未提供任何密钥，它将回退到标准的、非AI的提交信息模式。

核心功能使用

1. 查看仓库状态 (gissy status)
此命令提供了一个比原生git status更清晰、色彩更丰富的仓库状态视图，让您能快速了解哪些文件被修改、暂存或未被追踪。

gissy status

2. 查看仓库信息 (gissy info)
显示当前仓库的详细信息，包括远程仓库URL、最近的提交记录和分支情况。

gissy info

3. 管理分支 (gissy branch)
用于列出分支。它会高亮显示当前所在的分支。

# 列出所有本地分支
gissy branch
# 列出所有远程分支
gissy branch --remote
# 列出所有本地和远程分支
gissy branch --all

4. 自动配置SSH (gissy ssh)
对于初次向GitHub推送代码的用户，配置SSH密钥是一个常见障碍。此命令会自动检查、生成新的SSH密钥，并引导您将其添加到GitHub账户，实现无密码验证的git push.

gissy ssh

5. 启动智能文件监视器 (gissy watch)
这是Gissy的核心自动化功能。运行此命令后，Gissy会持续监控您项目中的文件改动。

gissy watch

当您保存一个文件时，watch工作流会启动：

• 检测改动: Gissy会立即发现文件发生了变化。
• 运行检查: 如果配置中runTestsim Gesang antwortenrunLintwegentrue，它会执行testCommandim Gesang antwortenlintCommand。如果检查失败，流程会中止，并将错误信息输出到控制台。
• 生成提交信息: 如果检查通过且useAIwegentrue，Gissy会使用您配置的AI服务商分析代码差异，并生成一条规范的提交信息。
• 暂存与提交: 自动将所有改动的文件添加到暂存区，并使用生成的信息进行提交。
• 推送代码: 最后，将提交推送到您在配置中指定的远程分支。

您还可以为watch命令添加参数以覆盖默认配置：

# 启动监视器并启用AI，同时输出详细日志
gissy watch --use-ai --verbose
# 临时忽略某些文件
gissy watch --ignore "*.tmp" "dist/**"

Anwendungsszenario

1. 初始化新项目
   当开始一个新项目时，开发者需要配置.gitignore文件，初始化Git仓库，并进行首次提交。使用gissy ssh可以快速配置好GitHub的访问权限，gissy watch则可以在编码过程中自动处理后续的提交和推送，极大地简化了项目启动流程。
2. 日常开发与编码
   在日常开发中，开发者通常需要频繁地在编码、测试、暂存、提交和推送之间切换。Gissy通过gissy watch命令将这一系列操作自动化，开发者只需专注于编写代码，保存文件后即可触发完整的质量检查和版本控制流程，从而减少上下文切换，提升开发效率。
3. 代码审查与团队协作
   在团队协作中，统一的提交信息规范至关重要。Gissy利用AI生成符合常规提交规范（Conventional Commits）的提交信息，确保了提交历史的清晰和一致性。这使得代码审查（Code Review）更加高效，团队成员也更容易理解每次变更的目的。
4. 重构或大型功能开发
   在进行大型重构或开发复杂功能时，会涉及大量的文件修改。手动管理这些提交既繁琐又容易出错。gissy watch可以持续在后台运行，自动将开发过程中的小步骤分批提交，形成一个清晰的、原子化的提交记录，便于后期追溯和回滚。

QA

1. Gissy是用什么技术构建的？
   Gissy主要使用JavaScript（ES modules）构建，并利用了多个流行的Node.js库，例如Commander.js用于构建命令行界面，Chokidar用于文件监控，Chalk用于美化终端输出。
2. 使用Gissy的AI功能是否必须付费？
   Gissy本身是免费开源的。但它的AI功能依赖于第三方AI服务商，如OpenAI或Google Gemini。使用这些服务通常需要您拥有对应的API密钥，并可能产生费用，具体取决于服务商的定价策略和您的使用量。
3. 如果我没有配置任何AI的API密钥，Gissy还能工作吗？
   可以。即使没有配置任何API密钥，Gissy依然可以正常工作。在这种情况下，当需要提交信息时，它会回退到一个简单的、基于文件改动列表的标准化提交信息，或者提示您手动输入。所有非AI相关的功能，如文件监视、自动测试和推送，都将不受影响。
4. Gissy是否会泄露我的代码？
   当启用AI功能时，Gissy会将您修改的代码片段（即git diff的内容）发送给您所配置的第三方AI服务商（如OpenAI），以便生成提交信息。您应该遵守您公司或项目的安全策略，并了解相应AI服务商的数据隐私政策。Gissy本身不会存储或将您的代码发送到其他任何地方。