README
¶
fastgit
agentic git commit generate tool
Documentation
- 文档索引：
docs/INDEX.md - 架构文档：
docs/architecture.md - 功能文档：
docs/features.md - 路线图文档：
docs/roadmap.md - 桌面端进度：
docs/desktop-status.md - Copilot DCOS：
docs/copilot-dcos.md
Desktop Client (Wails v3)
- 桌面端代码位于：
desktop/ - 该子项目不会影响现有 CLI（
main.go/bootstrap.Main()保持不变）
快速启动：
cd desktop
go run github.com/wailsapp/wails/v3/cmd/wails3@latest generate bindings -clean=true -ts -i
cd frontend && npm install && npm run build
cd ..
go run .
如果本机已安装 wails3，可直接在 desktop/ 下执行：
wails3 dev
Command Overview
fastgit commit: AI 提交流程（保留原行为）fastgit commit ai: AI 提交流程显式入口（新增）fastgit changelog init: 初始化.version/changelog模板，适配任意项目仓库fastgit changelog draft: 使用 Copilot 根据当前改动更新Unreleased.mdfastgit changelog release: 将Unreleased.md落版为版本文件，并可同步推进.version/VERSIONfastgit docs init: 初始化文档维护用的 prompt / instruction 模板fastgit pull: 拉取当前分支（支持--all/--rebase）fastgit pull --hard: 强制与远端同步（fetch + reset --hard）fastgit push: 推送当前分支（支持--all/--force）fastgit worktree: 列出当前仓库 worktreefastgit worktree create <issue|branch> [--base <branch>]: 创建 worktreefastgit worktree remove <issue|branch>: 删除 worktreefastgit worktree remove --path <worktree-path>: 按路径删除 worktreefastgit status/fastgit status short: 查看工作区状态fastgit add <file|.>: 暂存文件fastgit log/fastgit log graph: 查看提交记录fastgit diff [--staged|--unstaged]: 查看改动fastgit branch current|list|checkout <name>|checkout-remote <name>|create <name>|delete <name>: 分支操作fastgit fetch [--prune]: 拉取远端更新fastgit rebase <upstream>/fastgit rebase --continue|--abort|--skip: 变基操作fastgit remote/fastgit remote list: 查看远程仓库fastgit tag show <tag>: 查看 tag 详情fastgit ui: 进入交互模式（fuzzy 搜索 + workflow + alias）fastgit ui list: 查看交互命令面（含 alias）fastgit ui path: 查看当前ggc.yaml的实际路径（按 OS/XDG 规则）
Repo Prompt Templates
fastgit 现在支持为仓库初始化一组可直接复用的 Copilot prompt / instruction 模板，适合把常用工作流沉淀到项目里，而不是只存在聊天上下文中。
Changelog 模板
- 初始化：
fastgit changelog init - 生成后会创建：
.version/changelog/*.github/prompts/changelog.prompt.md.github/instructions/changelog.instructions.md.github/instructions/release.instructions.md
适合场景：
- 维护
Unreleased.md - 准备版本落版
- 统一 changelog 分类与发布流程
Documentation 模板
- 初始化：
fastgit docs init - 生成后会创建：
.github/prompts/documentation.prompt.md.github/prompts/commit-message.prompt.md.github/instructions/documentation.instructions.md
适合场景：
- 更新
README.md - 同步
docs/** - 维护
example/**/README.md - 生成或沉淀提交信息 / 提交流程 prompt 模板
- 让文档写作遵循统一中文技术文风与结构规范
Commit Prompt 模板
仓库中还可以维护提交辅助 prompt，例如：
.github/prompts/commit-message.prompt.md
当前这类 prompt 可用于：
- 基于 staged / working tree 改动生成提交信息
- 按模板约束执行本地提交
- 按模板约束继续推送到远程（如果 prompt 明确要求）
建议：把“生成建议”和“执行提交”区分成不同 prompt，便于在不同风险场景下选择更稳妥的工作流。
Git command surface
常用 git 操作已摊平为顶层子命令（原 ggc 统一入口已拆分）：
fastgit status|status shortfastgit add <file|.>fastgit log|log graphfastgit diff [--staged|--unstaged]fastgit branch current|list [--remote]|checkout <name>|checkout-remote <name>|create <name>|delete <name>fastgit fetch [--prune]fastgit pull [--all|--rebase|--hard]fastgit push [--all|--force]fastgit rebase <upstream>|--continue|--abort|--skipfastgit tag list|show <tag>fastgit remote|remote list
原
fastgit ggc commit <message>已移除：带 message 的提交直接使用git commit -m，AI 提交使用fastgit commit。
Interactive Mode
- 入口：
fastgit ui或fastgit ui interactive - 搜索模式（默认）
- 输入字符：实时 fuzzy 过滤命令
↑/↓或Ctrl+N/P：移动选中Enter：执行当前命令Tab：将当前命令加入当前 workflowCtrl+T：切换到 workflow 模式Ctrl+C：退出
- workflow 模式
n：新建 workflowd/Ctrl+D：删除当前 workflowc：清空当前 workflowCtrl+N/P：切换 workflowx或Enter：执行当前 workflowCtrl+T：返回搜索模式
对于带占位参数的命令（如
<name>），执行时会自动提示输入参数。
Workflow 持久化 + Alias
- workflow 会持久化到：
<XDG 配置目录>/fastgit/ggc.yaml- macOS 常见为：
~/Library/Application Support/fastgit/ggc.yaml - Linux 常见为：
~/.config/fastgit/ggc.yaml
- macOS 常见为：
- 每次进入
fastgit ui交互模式会自动加载上次 workflow - 在交互模式里对 workflow 的新增/删除/清空会自动保存
Alias 配置
ggc.yaml 支持两种 alias：
- 单条 alias（字符串）
- 序列 alias（字符串数组，按顺序执行）
示例：
aliases:
st: "status short"
ci: "commit {0}"
quick:
- "status"
- "add ."
- "commit {0}"
说明：
{0}、{1}... 表示位置参数- 例如：
fastgit ui ci "fix typo" - 例如：
fastgit ui quick "chore: update" fastgit ui list会同时显示内置命令与 alias
Refer
ENV
- OPENAI_API_KEY
- OPENAI_BASE_URL, default: https://api.deepseek.com/v1
- OPENAI_MODEL, default: deepseek-chat
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmds
|
|
|
fzfmain
command
|
|
|
gitcmds/commit
command
|
|
|
gitcmds/status
command
|
|
|
singlecursor
command
|
|
|
spin
command
Example application that uses all of the available API options.
|
Example application that uses all of the available API options. |
|
testcmd
command
|
|
|
example
|
|
|
auto-agentline-input
command
|
|
|
copilot-demo
command
|
|
|
fastcommit
command
|
|
|
pkg
|
|
|
acpclient
Package acpclient 提供 fastgit 作为 ACP Client 的最小可用实现: spawn 外部 ACP agent 子进程,通过 stdio JSON-RPC 完成 initialize -> session/new -> session/prompt,并收集 agent_message 文本。
|
Package acpclient 提供 fastgit 作为 ACP Client 的最小可用实现: spawn 外部 ACP agent 子进程,通过 stdio JSON-RPC 完成 initialize -> session/new -> session/prompt,并收集 agent_message 文本。 |
|
acpconfig
Package acpconfig 管理 fastgit 配置文件中的 acp: 段: 读取、解析、选择默认 agent,以及供 `ggc acp` 子命令使用的写回操作。
|
Package acpconfig 管理 fastgit 配置文件中的 acp: 段: 读取、解析、选择默认 agent,以及供 `ggc acp` 子命令使用的写回操作。 |
|
acpui
Package acpui 提供 ACP 权限请求的终端交互实现(tap 确认)。
|
Package acpui 提供 ACP 权限请求的终端交互实现(tap 确认)。 |
|
genaiclient
command
|
|
Click to show internal directories.
Click to hide internal directories.