非目标

• 实现一个功能齐全的 Git 客户端。
• 创建一个具有复杂 UI 的 TUI 应用程序。

要求

• Git
• 支持的终端仿真器
  • 有关详细信息，请参阅 兼容性。

安装

Cargo

$ cargo install --locked serie

Arch Linux

$ pacman -S serie

Homebrew (macOS)

$ brew install lusingander/tap/serie

下载二进制文件

您可以从 发布 下载预编译的二进制文件。

从源代码构建

如果您想检查最新开发版本，请从源代码构建

$ git clone https://github.com/lusingander/serie.git
$ cd serie
$ cargo build --release
$ ./target/release/serie

[!注意] 如果不是发布构建，速度非常慢。

使用说明

基本

在你的git仓库所在目录中运行 serie。

$ cd <your git repository>
$ serie

选项

Serie - A rich git commit graph in your terminal, like magic 📚

Usage: serie [OPTIONS]

Options:
  -p, --protocol <TYPE>  Image protocol to render graph [default: iterm] [possible values: iterm, kitty]
  -o, --order <TYPE>     Commit ordering algorithm [default: chrono] [possible values: chrono, topo]
      --no-cache         Do not use graph image cache
  -h, --help             Print help
  -V, --version          Print version

-p, --protocol <类型>

用于渲染提交图图像的协议类型。

有关详细信息，请参阅 兼容性。

-o, --order <类型>

--order chrono 如果可能，将按提交日期对提交进行排序。

--order topo 如果可能，将按分支顺序连续排序提交。

--no-cache

生成的图图像将保存到 $XDG_CACHE_HOME/serie 并重复使用。如果 $XDG_CACHE_HOME 未设置，则将使用 ~/.cache/。

如果指定了 --no-cache，则不会使用或保存此缓存图像。

快捷键

您可以通过按下 ? 键来查看快捷键。

配置

如果 $XDG_CONFIG_HOME/serie/config.toml 存在，它将被读取并使用。如果 $XDG_CONFIG_HOME 未设置，则将使用 ~/.cache/。

如果配置文件不存在，将使用所有项目的默认值。如果配置文件存在但某些项目未设置，则将使用默认值设置未设置的项目。

配置文件格式

此示例中设置的值是默认值。

[ui.list]
# The minimum width of a subject in the commit list.
# type: u16
subject_min_width = 20
# The date format of a author date in the commit list.
# The format must be specified in strftime format.
# https://docs.rs/chrono/latest/chrono/format/strftime/index.html
# type: string
date_format = "%Y-%m-%d"
# The width of a author date in the commit list.
# type: u16
date_width = 10
# The width of a author name in the commit list.
# type: u16
name_width = 20

[ui.detail]
# The date format of a author/committer date in the commit detail.
# The format must be specified in strftime format.
# https://docs.rs/chrono/latest/chrono/format/strftime/index.html
# type: string
date_format = "%Y-%m-%d %H:%M:%S %z"

兼容性

支持的终端

以下协议受支持

• 内联图像协议（iTerm2）
• 终端图形协议（kitty）

以下终端已确认可以工作。

内联图像协议

终端图形协议

报告兼容性

请在其他终端仿真器上分享您的体验 讨论。

贡献

欢迎贡献。请查看 CONTRIBUTING.md 以开始。

截图

以下仓库用于这些示例

• ratatui-org/ratatui
• charmbracelet/vhs
• lusingander/stu

许可证

MIT