终端党的福音!开源Git命令速查工具Git Cheat Sheet TUI

终端党的福音!开源Git命令速查工具Git Cheat Sheet TUI

🔗 GitHub仓库ciclebyte/git-cheat-sheet-tui

在日常开发中,Git 是版本控制的利器,但其命令繁多、参数组合复杂,常常让人头疼。为了解决这些问题,我开源了一款终端 Git 速查工具 ------ Git Cheat Sheet TUI。它不仅能帮助你快速查找和掌握 Git 命令,还能通过终端用户界面(TUI)提供流畅的操作体验。

痛点场景

你是否遇到过以下困扰?

  1. Git命令记不住:命令和参数繁多,经常需要反复查询文档。
  2. 工作流被打断:频繁切换到浏览器查询命令,影响开发效率。
  3. 速查表缺乏交互:传统速查表只能静态查看,无法快速定位所需信息。

工具简介

Git Cheat Sheet TUI 是一款专为开发者设计的终端 Git 速查工具,具备以下亮点:

🌟 核心功能

  • 全键盘操作 :支持 ←→↑↓ 快速导航,无需鼠标,提升效率。
  • 即时搜索 :通过 Ctrl+F 快速定位命令,支持模糊匹配。
  • 分类查看:按功能模块(如分支、提交、合并等)归类命令,方便查找。
  • 详细说明:支持 Markdown 格式的命令文档,直观查看用法和示例。

安装体验

只需几步,即可体验 Git Cheat Sheet TUI 的强大功能:

bash 复制代码
# 克隆项目(需 Go 环境)
git clone https://github.com/ciclebyte/git-cheat-sheet-tui
cd git-cheat-sheet-tui

# 编译并运行
go build
./gitsheet -l  # 显示日志面板
./gitsheet -s reset  # 直接搜索 reset 命令

效果展示

主界面 - 按分类浏览 Git 命令

搜索模式 - 支持模糊匹配,快速定位命令

技术选型

  • 终端界面 :基于 tview 构建,提供流畅的交互体验。
  • 数据库加速:使用 SQLite 内存数据库,提升查询效率。
  • 颜色渲染:集成 ANSI 颜色引擎,增强界面视觉效果。
  • Markdown 解析:支持 Markdown 格式的命令文档,信息展示更清晰。

使用说明

快捷键

  • /:切换焦点。
  • /:导航列表。
  • Ctrl+F:开启搜索模式。
  • Ctrl+R:重置搜索。
  • Q:退出程序。

命令行参数

  • -s--search:启动时直接搜索指定命令。
  • -l--showlog:显示日志面板。

示例

  1. 启动程序并显示日志面板:

    bash 复制代码
    ./gitsheet -l
  2. 启动时直接搜索 "commit" 命令:

    bash 复制代码
    ./gitsheet -s commit
  3. 启动时直接搜索 "branch" 命令并显示日志面板:

    bash 复制代码
    ./gitsheet -s branch -l

安装指南

前置要求

  • Go 1.21 或更高版本
  • Git
  • Python3(可选,用于生成命令元数据)

安装步骤

  1. 克隆仓库:

    bash 复制代码
    git clone https://github.com/ciclebyte/git-cheat-sheet-tui.git
    cd git-cheat-sheet-tui
  2. 安装依赖:

    bash 复制代码
    go mod tidy
  3. 编译项目:

    bash 复制代码
    go build
  4. 运行程序:

    bash 复制代码
    ./gitsheet

开发与贡献

Git Cheat Sheet TUI 是一个开源项目,我们欢迎所有开发者的参与!如果你有任何建议或改进意见,欢迎提交 Issue 或 Pull Request。

主要依赖

  • github.com/rivo/tview:终端用户界面框架。
  • github.com/gdamore/tcell/v2:终端界面渲染。
  • github.com/mattn/go-sqlite3:SQLite 数据库驱动。
  • github.com/charmbracelet/glamour:Markdown 渲染。
  • github.com/spf13/cobra:命令行参数处理。

脚本说明

我们提供了多种 Python 脚本,用于生成命令元数据、构建数据库和调用 AI 模型生成文档。确保提前安装相关依赖:

bash 复制代码
pip install openai pyyaml sqlalchemy

许可证

本项目采用 MIT 许可证 ,详情请查看 LICENSE 文件。

Git Cheat Sheet TUI 不仅是一个工具,更是你对 Git 命令的"百科全书"。无论是日常开发还是提升效率,它都能为你提供极大帮助。快来体验吧! 🚀

相关推荐
码厂一粒沙1 小时前
【代码管理】git使用指南(新手向)
git
white-persist1 小时前
Python实例方法与Python类的构造方法全解析
开发语言·前端·python·原型模式
Java 码农2 小时前
Centos7 maven 安装
java·python·centos·maven
倔强青铜三2 小时前
苦练Python第63天:零基础玩转TOML配置读写,tomllib模块实战
人工智能·python·面试
浔川python社3 小时前
《网络爬虫技术规范与应用指南系列》(xc—3):合规实操与场景落地
python
B站计算机毕业设计之家3 小时前
智慧交通项目:Python+YOLOv8 实时交通标志系统 深度学习实战(TT100K+PySide6 源码+文档)✅
人工智能·python·深度学习·yolo·计算机视觉·智慧交通·交通标志
IT森林里的程序猿3 小时前
基于机器学习方法的网球比赛胜负趋势预测
python·机器学习·django
正牌强哥3 小时前
Futures_ML——机器学习在期货量化交易中的应用与实践
人工智能·python·机器学习·ai·交易·akshare
倔强青铜三3 小时前
苦练Python第62天:零基础玩转CSV文件读写,csv模块实战
人工智能·python·面试
郝学胜-神的一滴3 小时前
Effective Python 第43条:自定义容器类型为什么应该从 `collections.abc` 继承?
开发语言·python