Skidmarks

Skidmarks 是一个用 Rust 编写的命令行应用程序，用于管理连续记录。它允许用户添加和列出不同频率（每日或每周）的连续记录，并检查这些连续记录以保持它们。

功能

• 使用指定的名称和频率添加新的连续记录。
• 列出所有现有的连续记录。
• 检查连续记录以保持其进行。
• 当不再需要时删除连续记录。
• 提供 CLI、TUI 和 GUI 界面。

安装

要安装 Skidmarks，您需要在您的系统上安装 Rust 和 Cargo。您可以使用 rustup 安装 Rust。

cargo install --locked skidmarks

或手动安装

# Clone the repository
git clone https://github.com/kennethlove/skidmarks.git

# Navigate to the project directory
cd skidmarks

# Build the project
cargo build --release

使用方法

添加连续记录

要添加新的连续记录，请使用带有 add 命令和 --name 以及 --frequency 选项。

# Add a daily streak
$ skidmarks add --name "Exercise" --frequency daily

🎉 Created a new daily streak: Exercise

# Add a weekly streak
$ skidmarks add --name "Read a book" --frequency weekly

🎉 Created a new weekly streak: Read a book

列出所有连续记录

要列出所有现有的连续记录，请使用 list 命令。

$ skidmarks list

   | Streak          | Freq   | Status | Last Check In | Total
---+-----------------+--------+--------+---------------+-------
 0 | Exercise        | daily  | ✅     |  2024-07-31   |   1
 1 | Wordle          | daily  | ✅     |  2024-07-31   |   1
 2 | Coloring page   | daily  | ✅     |  2024-07-31   |   1
 3 | Duolingo        | daily  | ✅     |  2024-07-31   |   1
 4 | Animal Crossing | daily  | ❌     |     None      |   0
 5 | Read a book     | weekly | ❌     |     None      |   0

过滤连续记录

您可以使用 --done、--waiting 或 --missed 标志来过滤连续记录列表。

您可以使用 --daily 和 --weekly 标志按频率过滤。

搜索连续记录

您可以使用 --search 标志来搜索连续记录列表。

$ skidmarks list --search "Exercise"

   | Streak          | Freq   | Status | Last Check In | Total
---+-----------------+--------+--------+---------------+-------
 0 | Exercise        | daily  | ✅     |  2024-07-31   |   1

检查连续记录

要检查连续记录，请使用 check-in <连续记录 ID> 命令。

$ skidmarks check-in 0

🌟 Checked in on the "Exercise" streak!

删除连续记录

要删除连续记录，请使用 remove <连续记录 ID> 命令。

$ skidmarks remove 5

🗑 Removed the "Read a book" streak

TUI

Skidmarks 提供了一个 TUI 界面。要使用它，请运行以下命令

skidmarks tui

GUI

Skidmarks 提供了一个 GUI 界面。要使用它，请运行以下命令

skidmarks gui

运行测试

要为此项目运行测试，请使用以下命令

cargo test

贡献

欢迎贡献！请为任何改进或错误修复打开一个问题或提交一个拉取请求。

许可

本项目受 Apache 许可证许可。有关详细信息，请参阅 LICENSE 文件。