lazygit自定义命令教程：打造专属Git工作流自动化

为什么需要自定义命令？

你的Git工作流是否还在重复这些低效操作？

• 提交代码时反复输入git commit -m "fix: xxx"
• 切换分支时手动输入冗长的分支命名规范
• 查看提交记录需打开浏览器访问仓库
• 不同情境下执行相似命令却要记忆多种快捷键

lazygit自定义命令系统通过可视化配置将这些操作压缩为单键触发，配合上下文感知和动态参数，让Git操作效率提升300%。本文将从基础配置到高级自动化，带你构建专属于你的Git命令生态。

快速入门：3分钟实现第一个自定义命令

配置文件位置

通过e键（在状态面板）快速打开配置文件config.yml，或手动编辑：

• Linux/macOS: ~/.config/lazygit/config.yml
• Windows: %APPDATA%\lazygit\config.yml

基础示例：文件暂存切换

customCommands:
  - key: 'a'                  # 快捷键：a
    context: 'files'          # 生效上下文：文件面板
    command: "git {{if .SelectedFile.HasUnstagedChanges}} add {{else}} reset {{end}} {{.SelectedFile.Name | quote}}"
    description: '一键切换文件暂存状态'  # 菜单显示描述

核心参数解析：

参数	说明	可选值
key	触发快捷键	单字母/组合键（如<c-a>=Ctrl+A）
context	生效面板	files/commits/branches等18种上下文
command	执行命令	支持Go模板语法动态生成
description	菜单描述	显示在?帮助面板

上下文系统：让命令"聪明"起来

18种上下文覆盖全场景

lazygit通过上下文隔离避免快捷键冲突，常用上下文：

pie
  title 常用上下文分布
  "files" : 25
  "commits" : 20
  "branches" : 15
  "global" : 10
  "others" : 30

多上下文配置（用逗号分隔）：

context: 'commits,subCommits'  # 同时在提交列表和子提交列表生效

上下文感知示例：智能提交

- key: 'C'
  context: 'global'
  command: |
    {{if .SelectedFile}}
      git commit -m "feat: modify {{.SelectedFile.Name}}"
    {{else}}
      git commit
    {{end}}
  output: 'terminal'  # 在终端显示命令输出

动态参数：让命令"活"起来

内置对象模型

通过.语法访问当前选中项属性，常用对象：

对象	说明	示例属性
.SelectedFile	选中文件	.Name/.HasUnstagedChanges
.SelectedLocalBranch	本地分支	.Name/.Upstream
.SelectedCommit	提交记录	.Hash/.AuthorName

提交哈希访问示例：

- key: '<c-b>'
  context: 'commits'
  command: 'git show {{.SelectedCommit.Hash}}'  # 显示选中提交详情
  output: 'popup'  # 弹窗显示结果

Go模板语法进阶

支持条件判断、循环等高级逻辑：

command: |
  {{if eq .SelectedBranch.Name "main"}}
    echo "不能直接操作主分支" && exit 1
  {{else}}
    git checkout {{.SelectedBranch.Name}}
  {{end}}

交互式命令：通过提示框收集输入

4种提示类型全覆盖

flowchart LR
  A[提示类型] --> B[input 文本输入]
  A --> C[confirm 确认对话框]
  A --> D[menu 菜单选择]
  A --> E[menuFromCommand 命令生成菜单]

实战案例：规范化分支创建

- key: 'n'
  context: 'localBranches'
  description: '创建规范化分支'
  prompts:
    - type: 'menu'          # 菜单选择
      title: '分支类型'
      key: 'BranchType'
      options:
        - name: '功能分支'
          value: 'feature'
          description: '新功能开发'
        - name: '修复分支'
          value: 'hotfix'
          description: '生产环境修复'
    - type: 'input'         # 文本输入
      title: '分支名称'
      key: 'BranchName'
      initialValue: 'user-center-'  # 默认值
  command: 'git checkout -b {{.Form.BranchType}}/{{.Form.BranchName}}'

执行流程：

1. 按n触发 → 显示分支类型菜单
2. 选择类型 → 输入分支名称
3. 自动执行：git checkout -b feature/user-center-xxx

高级提示：命令输出转菜单

从命令输出动态生成选项：

- key: 'o'
  context: 'global'
  prompts:
    - type: 'menuFromCommand'
      title: '选择文件打开'
      key: 'FileName'
      command: 'ls -la | grep "^-" | awk "{print $9}"'  # 列出当前目录文件
  command: 'code {{.Form.FileName | quote}}'  # 用VSCode打开选中文件

工作流自动化：5个场景化方案

1. 提交记录快速浏览

- key: '<c-b>'
  context: 'commits'
  command: 'git browse -- "commit/{{.SelectedCommit.Hash}}"'  # 需安装hub工具
  description: '在浏览器打开当前提交'

2. 批量操作提交

- key: 'p'
  context: 'commits'
  command: 'git format-patch {{.SelectedCommitRange.From}}^..{{.SelectedCommitRange.To}} -o patches/'
  description: '生成选中范围提交的补丁'

3. Git Flow工作流集成

- key: 'f'
  context: 'localBranches'
  prompts:
    - type: 'menu'
      key: 'Action'
      options:
        - value: 'start'
        - value: 'finish'
    - type: 'input'
      key: 'FeatureName'
  command: 'git flow feature {{.Form.Action}} {{.Form.FeatureName}}'

4. 冲突检测与处理

- key: 'x'
  context: 'global'
  command: 'git mergetool'
  after:
    checkForConflicts: true  # 命令执行后检查冲突
  description: '启动合并工具并检查冲突'

5. 自定义命令菜单

将低频命令组织成菜单：

- key: 'X'
  description: '高级工具集'
  commandMenu:
    - key: 'c'
      command: 'git cherry-pick {{.SelectedCommit.Hash}}'
      context: 'commits'
      description: '拣选当前提交'
    - key: 's'
      command: 'git stash save "{{.SelectedCommit.Message}}"'
      context: 'commits'
      description: '基于提交创建暂存'

高级技巧：让命令更强大

1. 安全引用：quote函数

自动处理文件名空格与特殊字符：

command: 'git add {{.SelectedFile.Name | quote}}'  # 等价于"git add 'file name.txt'"

2. 命令嵌套：runCommand函数

在模板中执行命令获取结果：

command: 'echo "今日提交数: {{runCommand "git rev-list --count HEAD --since=today"}}"'

3. 条件渲染：复杂逻辑处理

command: |
  {{if .SelectedFile.IsDir}}
    git add {{.SelectedFile.Name | quote}}/**/*
  {{else}}
    git add {{.SelectedFile.Name | quote}}
  {{end}}

4. 快捷键冲突处理

• 同上下文：自定义命令覆盖内置命令
• 全局上下文 < 特定上下文（如files上下文快捷键优先于global）

查看所有快捷键：按?打开帮助面板，自定义命令会标记[CUSTOM]

调试与分享

调试技巧

1. 命令预览：用echo包装命令查看渲染结果

   command: 'echo "git add {{.SelectedFile.Name | quote}}"'  # 仅显示不执行
   output: 'popup'  # 弹窗显示结果
   

2. 错误日志：查看~/.local/share/lazygit/logs（Linux）

命令分享与社区资源

• 官方示例库：https://gitcode.com/GitHub_Trending/la/lazygit/wiki/Custom-Commands-Compendium
• 推荐工具：结合hub(GitHub命令行)、gh(GitLab命令行)扩展功能

总结与进阶路线

timeline
    title 自定义命令掌握路线
    初级 : 基础配置、单键命令、简单上下文
    中级 : 动态参数、条件判断、提示框交互
    高级 : 命令菜单、工作流自动化、模板函数
    专家 : 跨仓库命令、外部工具集成、团队共享配置

下一步行动：

1. 复制本文示例到你的config.yml
2. 按e打开配置文件，添加第一个自定义命令
3. 探索?帮助面板中的现有快捷键，找出可优化空间

通过自定义命令系统，lazygit不仅是Git客户端，更成为你的个人Git操作中台。将重复操作抽象为命令，让大脑专注于更具创造性的工作 — 这才是效率工具的终极意义。

提示：定期同步官方文档，lazygit团队每季度都会新增上下文和模板功能。