#contributions #github #git #tui #system-information

app gitfetch

一个命令行工具,用于获取并显示 Git 贡献信息

1 个不稳定版本

0.1.1 2024年7月30日
0.1.0 2024年7月30日

#292开发工具

Download history 252/week @ 2024-07-30 4/week @ 2024-08-06

每月 256 次下载

GPL-3.0 许可证

32KB
621

Gitfetch

Gitfetch 是一个用 Rust 编写的命令行信息工具,灵感来自 Neofetch。它提供了一种视觉上吸引人的方式来显示 Git 贡献信息。

目录

特性

  • 打印出与 Neofetch 显示系统信息相似的贡献信息
  • 自动检测全局 Git 用户
  • 允许指定任何用户和年份的贡献数据
  • 可自定义贡献图和输出颜色

安装

先决条件

  • Git(可选,用于全局用户检测)

Arch Linux

sudo pacman -S gitfetch

Homebrew

brew install gitfetch

从 crates.io 安装

使用 Cargo 直接从 crates.io 安装 Gitfetch

cargo install --locked gitfetch

用法

  1. 使用具有 read:user 范围的 GitHub Token 生成新的 GitHub 令牌以从 GitHub 获取数据。

  2. 将您的令牌添加到 Gitfetch

    gitfetch add-token <your-token-here>
    
  3. 运行 Gitfetch

    gitfetch
    

可选参数

  • -u--user:指定一个 GitHub 用户名
  • -y--year:指定贡献数据的年份

示例

gitfetch -u FabricSoul -y 2023

配置

配置路径是 ~/.config/gitfetch/config.toml

[graph_colors]

level1: "r,g,b" level2: "r,g,b" level3: "r,g,b" level4: "r,g,b"

[text_colors]

info_color: "r,g,b"

[graph_data]

percentiles: [usize,uszie,uszie,uszie]

路线图

  • 自定义图形颜色
  • 自定义输出文本颜色
  • 自定义图形显示
  • 使用 git 获取用户名
  • 指定用户
  • 指定年份
  • 显示最高贡献
  • 显示最长连续贡献
  • 显示当前连续贡献
  • 支持其他 Git 托管平台

贡献

我们欢迎对 Gitfetch 的贡献!以下是如何帮助的说明

  1. 分支项目
  2. 创建您的功能分支(git checkout -b feature/AmazingFeature
  3. 提交您的更改(git commit -m '添加一些AmazingFeature'
  4. 推送到分支(git push origin feature/AmazingFeature
  5. 打开一个拉取请求

许可证

本项目采用GPL-3.0许可协议 - 详细信息请参阅LICENSE文件。


注意:Gitfetch正在积极开发中。功能和文档可能不完整或可能发生变化。我们感谢您的反馈和贡献!

依赖项

~12–24MB
~372K SLoC