Skip to content

Releases

v0.2.1

Choose a tag to compare

@github-actions github-actions released this 06 Nov 18:34
144abe4

Coffee Clock 使用说明

Coffee Clock 是一款在终端中运行的倒计时与番茄钟工具,以大号艺术字显示时间,适合专注工作、学习和休息。支持暂停与继续、自动工作/休息循环、查看本地时间,以及切换字体和颜色。

0.2.1 更新

  • 更新终端界面依赖,移除存在安全问题的旧版 lru 依赖;依赖安全审计纳入持续集成。
  • 从源码构建需要 Rust 1.88 或更新版本;预编译包可直接运行。
  • 修复自动依赖更新误改最低 Rust 版本的问题,暂缓引入不兼容且包含已知漏洞依赖的 FIGlet 更新。
  • 发布前在四个平台分别解压并运行发行包,核对版本、文档和许可证;提供 SHA256SUMS 校验文件。

0.2.0 功能回顾

  • 倒计时结束和番茄阶段切换时提供可关闭的终端响铃及文字提示。
  • 新增 :help、Ctrl-P / Ctrl-N 命令历史和 :save 配置保存。
  • 窗口不足时自动降级字体或使用普通数字,短窗口仍可输入命令;艺术字渲染结果会缓存复用。
  • 暂停状态持续可见,启动参数及配置错误在界面启动前报告。
  • 提供 Linux、Windows、Intel Mac 和 Apple Silicon Mac 发布包,附带文档和许可证。

下载后如何运行

  1. 下载与你的操作系统和处理器架构匹配的发布包(以发布页面实际提供的文件为准)。
  2. 将压缩包解压到方便使用的位置。
  3. 在解压目录打开终端,运行程序。使用预编译包不需要安装 Rust 或 Cargo;字体已内嵌,无需额外下载。

发布包名称中的 amd64 表示 Intel / AMD 64 位架构,arm64 表示 ARM 64 位架构;Apple Silicon Mac 请选择 coffee-macos-arm64,Intel Mac 请选择 coffee-macos-amd64。发布包附带使用文档、项目许可证和字体许可证,建议保留完整解压目录。

Windows

建议在 Windows Terminal 中使用 PowerShell 运行:

# 启动 25 分钟倒计时
.\coffee.exe --time 25m

# 启动番茄钟
.\coffee.exe --pomo

推荐将可执行包目录附加到环境变量,以使用 coffee 运行。

Linux / macOS

如果发布页面提供了对应平台的程序,在终端中运行:

# 若文件没有执行权限,先赋予权限
chmod +x ./coffee

# 启动 25 分钟倒计时
./coffee --time 25m

# 启动番茄钟
./coffee --pomo

请从终端启动,而不是仅双击程序,以便传入参数、查看提示和正常操作界面。

启动选项

以下示例使用 coffee 表示程序名;未加入 PATH 时,请替换为当前目录下的程序路径:Windows 为 .\coffee.exe,Linux / macOS 为 ./coffee。

启动方式 功能
coffee 立即启动 1 分钟倒计时
coffee --time 25m 立即启动 25 分钟倒计时
coffee -t 1h30m10s 立即启动 1 小时 30 分 10 秒倒计时
coffee --pomo 或 coffee -p 立即启动默认番茄钟
coffee --help 查看启动参数帮助
coffee --version 或 coffee -v 显示版本信息
coffee --coffee 显示程序信息
coffee --no-bell 本次运行关闭终端响铃
coffee --config config.toml 使用指定的配置文件
coffee --no-config 忽略配置并禁用保存

时长按小时 h、分钟 m、秒 s 的顺序组合,例如 1h30m10s、25m、45s,总时长必须大于零。不要输入 25:00 或不带单位的 25。--time 与 --pomo 不能同时使用;信息选项 --version 和 --coffee 请单独运行。

第一次使用

启动计时后即可直接查看剩余时间。需要操作时:

  1. 按 : 打开命令栏。
  2. 输入命令,例如 stop。
  3. 按 Enter 执行,或按 Esc 取消输入。

下表中的 : 表示先按冒号打开命令栏,再输入后面的内容。

操作 命令
暂停 :stop 或 :s
继续/启动已设置的计时 :continue 或 :c
重新开始 :restart 或 :r
以新时长立即重新开始普通倒计时 :restart 10m
设置普通倒计时时长,不立即开始 :countdown 10m 或 :cd 10m
切换本地时间/计时显示 :time 或 :t
进入番茄钟 :pomo
退出程序 :quit 或 :q

普通倒计时运行中,需要先暂停,才能使用 countdown 设置新时长;如果希望立即重新计时,可用 restart 10m。倒计时结束后会停留在 00:00:00,此时需要重新开始或设置新的时长,不能直接继续。

普通模式下只按 q 不会退出,请使用 :q 后按 Enter。

输入与补全

  • Tab 或 ↓:选择下一个候选;Shift-Tab 或 ↑:选择上一个候选。
  • ← / →、Home、End:移动输入光标。
  • Backspace、Delete:删除字符。
  • Esc:取消当前输入。
  • Ctrl-P / Ctrl-N:浏览本次运行的命令历史,回到最新记录后恢复输入草稿。

使用 :help 可查看内置帮助,方向键滚动,Esc 关闭;帮助打开时计时继续。

命令不区分大小写。进入命令栏或切换到本地时间显示不会暂停计时。

番茄钟

默认循环为:

  • 工作 25 分钟。
  • 前三个工作阶段结束后,各进行 5 分钟短休息。
  • 第四个工作阶段结束后,进行 15 分钟长休息。
  • 长休息结束后,自动开始新一轮。

所有阶段都会自动切换,也可以使用 :stop 和 :continue 暂停、继续。

底部状态栏会同时显示阶段与运行状态,例如 [Work | Running]、[Work | Paused];暂停状态不会随临时命令提示消失。

调整阶段时长

:worktime 45m
:breaktime 10m
:resttime 20m

这些设置在下一次进入对应阶段时生效,不改变当前阶段的剩余时间。若要立即使用新配置,可在番茄钟模式下执行:

:restart work
:restart break
:restart rest

重启指定阶段或使用无参数的 :restart,都会清零当前轮次已完成的工作次数。带时长的 :restart 10m 仅用于普通倒计时。

切换计时模式

使用 :pomo 进入番茄钟,使用 :countdown 25m 返回普通倒计时。替换未完成的倒计时或离开番茄钟时,需要确认:

  • y:确认。
  • n 或 Esc:取消。
  • ← / → 或 Tab:切换 Yes / No,Enter 提交;默认选择 No。

等待确认时,原计时仍然继续。返回普通倒计时后,使用 :continue 开始。

字体与颜色

:set font small
:sf mini
:set color orange
:sc #12ABEF

内置字体:standard(默认)、small、big、slant、mini、banner。

颜色支持常见英文名称,例如 cyan、green、orange、purple 和 pink,以及 #RRGGBB、#RGB 格式的 HEX 值。颜色名和字体名不区分大小写。

如果所选字体放不下,程序会尝试较小字体,最后回退为普通数字;扩大窗口后恢复所选字体。颜色效果取决于终端的色彩支持。

提醒与配置保存

倒计时结束和番茄阶段切换时会响铃,是否发声取决于终端设置。:set bell off 关闭、:set bell on 开启,也可使用 --no-bell 启动。一次延迟更新跨过多个阶段时,只针对最新阶段提醒一次。

执行 :save 将当前字体、颜色、三种番茄阶段时长和响铃设置保存至配置文件,下次启动时读取。默认位置及覆盖规则见 简体中文文档;配置示例位于 examples/config.toml。当前倒计时和命令历史不会跨进程恢复。

使用注意事项

  • 这是终端应用,请使用支持交互输入、光标控制和颜色显示的终端,而非将输出重定向到文件。
  • 阶段时长与外观设置需执行 :save 才会保存;退出后重新启动不会恢复上次计时会话。
  • 查看系统时间不会停止后台计时;需要暂停时请明确执行 :stop。
  • 请保持程序运行,不要依赖关闭终端或系统休眠期间的提醒;本工具不应作为关键事项的唯一提醒方式。

许可证

Coffee Clock 采用 MIT 许可证,版权主体为 Muimi272,详见项目的 LICENSE。内置字体的独立许可见 assets/fonts/LICENSE。

v0.2.0

Choose a tag to compare

@github-actions github-actions released this 03 Nov 10:06
3e9e4d1

Coffee Clock 使用说明

Coffee Clock 是一款在终端中运行的倒计时与番茄钟工具,以大号艺术字显示时间,适合专注工作、学习和休息。支持暂停与继续、自动工作/休息循环、查看本地时间,以及切换字体和颜色。

0.2.0 更新

  • 倒计时结束和番茄阶段切换时提供可关闭的终端响铃及文字提示。
  • 新增 :help、Ctrl-P / Ctrl-N 命令历史和 :save 配置保存。
  • 窗口不足时自动降级字体或使用普通数字,短窗口仍可输入命令;艺术字渲染结果会缓存复用。
  • 暂停状态持续可见,启动参数及配置错误在界面启动前报告。
  • 提供 Linux、Windows、Intel Mac 和 Apple Silicon Mac 发布包,附带文档和许可证。

下载后如何运行

  1. 下载与你的操作系统和处理器架构匹配的发布包(以发布页面实际提供的文件为准)。
  2. 将压缩包解压到方便使用的位置。
  3. 在解压目录打开终端,运行程序。使用预编译包不需要安装 Rust 或 Cargo;字体已内嵌,无需额外下载。

发布包名称中的 amd64 表示 Intel / AMD 64 位架构,arm64 表示 ARM 64 位架构;Apple Silicon Mac 请选择 coffee-macos-arm64,Intel Mac 请选择 coffee-macos-amd64。发布包附带使用文档、项目许可证和字体许可证,建议保留完整解压目录。

Windows

建议在 Windows Terminal 中使用 PowerShell 运行:

# 启动 25 分钟倒计时
.\coffee.exe --time 25m

# 启动番茄钟
.\coffee.exe --pomo

推荐将可执行包目录附加到环境变量,以使用 coffee 运行。

Linux / macOS

如果发布页面提供了对应平台的程序,在终端中运行:

# 若文件没有执行权限,先赋予权限
chmod +x ./coffee

# 启动 25 分钟倒计时
./coffee --time 25m

# 启动番茄钟
./coffee --pomo

请从终端启动,而不是仅双击程序,以便传入参数、查看提示和正常操作界面。

启动选项

以下示例使用 coffee 表示程序名;未加入 PATH 时,请替换为当前目录下的程序路径:Windows 为 .\coffee.exe,Linux / macOS 为 ./coffee。

启动方式 功能
coffee 立即启动 1 分钟倒计时
coffee --time 25m 立即启动 25 分钟倒计时
coffee -t 1h30m10s 立即启动 1 小时 30 分 10 秒倒计时
coffee --pomo 或 coffee -p 立即启动默认番茄钟
coffee --help 查看启动参数帮助
coffee --version 或 coffee -v 显示版本信息
coffee --coffee 显示程序信息
coffee --no-bell 本次运行关闭终端响铃
coffee --config config.toml 使用指定的配置文件
coffee --no-config 忽略配置并禁用保存

时长按小时 h、分钟 m、秒 s 的顺序组合,例如 1h30m10s、25m、45s,总时长必须大于零。不要输入 25:00 或不带单位的 25。--time 与 --pomo 不能同时使用;信息选项 --version 和 --coffee 请单独运行。

第一次使用

启动计时后即可直接查看剩余时间。需要操作时:

  1. 按 : 打开命令栏。
  2. 输入命令,例如 stop。
  3. 按 Enter 执行,或按 Esc 取消输入。

下表中的 : 表示先按冒号打开命令栏,再输入后面的内容。

操作 命令
暂停 :stop 或 :s
继续/启动已设置的计时 :continue 或 :c
重新开始 :restart 或 :r
以新时长立即重新开始普通倒计时 :restart 10m
设置普通倒计时时长,不立即开始 :countdown 10m 或 :cd 10m
切换本地时间/计时显示 :time 或 :t
进入番茄钟 :pomo
退出程序 :quit 或 :q

普通倒计时运行中,需要先暂停,才能使用 countdown 设置新时长;如果希望立即重新计时,可用 restart 10m。倒计时结束后会停留在 00:00:00,此时需要重新开始或设置新的时长,不能直接继续。

普通模式下只按 q 不会退出,请使用 :q 后按 Enter。

输入与补全

  • Tab 或 ↓:选择下一个候选;Shift-Tab 或 ↑:选择上一个候选。
  • ← / →、Home、End:移动输入光标。
  • Backspace、Delete:删除字符。
  • Esc:取消当前输入。
  • Ctrl-P / Ctrl-N:浏览本次运行的命令历史,回到最新记录后恢复输入草稿。

使用 :help 可查看内置帮助,方向键滚动,Esc 关闭;帮助打开时计时继续。

命令不区分大小写。进入命令栏或切换到本地时间显示不会暂停计时。

番茄钟

默认循环为:

  • 工作 25 分钟。
  • 前三个工作阶段结束后,各进行 5 分钟短休息。
  • 第四个工作阶段结束后,进行 15 分钟长休息。
  • 长休息结束后,自动开始新一轮。

所有阶段都会自动切换,也可以使用 :stop 和 :continue 暂停、继续。

底部状态栏会同时显示阶段与运行状态,例如 [Work | Running]、[Work | Paused];暂停状态不会随临时命令提示消失。

调整阶段时长

:worktime 45m
:breaktime 10m
:resttime 20m

这些设置在下一次进入对应阶段时生效,不改变当前阶段的剩余时间。若要立即使用新配置,可在番茄钟模式下执行:

:restart work
:restart break
:restart rest

重启指定阶段或使用无参数的 :restart,都会清零当前轮次已完成的工作次数。带时长的 :restart 10m 仅用于普通倒计时。

切换计时模式

使用 :pomo 进入番茄钟,使用 :countdown 25m 返回普通倒计时。替换未完成的倒计时或离开番茄钟时,需要确认:

  • y:确认。
  • n 或 Esc:取消。
  • ← / → 或 Tab:切换 Yes / No,Enter 提交;默认选择 No。

等待确认时,原计时仍然继续。返回普通倒计时后,使用 :continue 开始。

字体与颜色

:set font small
:sf mini
:set color orange
:sc #12ABEF

内置字体:standard(默认)、small、big、slant、mini、banner。

颜色支持常见英文名称,例如 cyan、green、orange、purple 和 pink,以及 #RRGGBB、#RGB 格式的 HEX 值。颜色名和字体名不区分大小写。

如果所选字体放不下,程序会尝试较小字体,最后回退为普通数字;扩大窗口后恢复所选字体。颜色效果取决于终端的色彩支持。

提醒与配置保存

倒计时结束和番茄阶段切换时会响铃,是否发声取决于终端设置。:set bell off 关闭、:set bell on 开启,也可使用 --no-bell 启动。一次延迟更新跨过多个阶段时,只针对最新阶段提醒一次。

执行 :save 将当前字体、颜色、三种番茄阶段时长和响铃设置保存至配置文件,下次启动时读取。默认位置及覆盖规则见 简体中文文档;配置示例位于 examples/config.toml。当前倒计时和命令历史不会跨进程恢复。

使用注意事项

  • 这是终端应用,请使用支持交互输入、光标控制和颜色显示的终端,而非将输出重定向到文件。
  • 阶段时长与外观设置需执行 :save 才会保存;退出后重新启动不会恢复上次计时会话。
  • 查看系统时间不会停止后台计时;需要暂停时请明确执行 :stop。
  • 请保持程序运行,不要依赖关闭终端或系统休眠期间的提醒;本工具不应作为关键事项的唯一提醒方式。

许可证

Coffee Clock 采用 MIT 许可证,版权主体为 Muimi272,详见项目的 LICENSE。内置字体的独立许可见 assets/fonts/LICENSE。

v0.1.0

Choose a tag to compare

@github-actions github-actions released this 28 Oct 14:26