1 个不稳定版本

0.1.0 2024年3月8日

#243配置

GPL-2.0-or-later

155KB
3.5K SLoC

pwalarmd/pwalarmctl

Crates version pwalarmd Crates version pwalarmctl GitHub version License

pwalarmd 是一个基于命令行(守护进程)的终端报警系统。它具有

  • ⏰ 可配置你想要的所有报警
  • 🎨 许多个性化选项,包括自定义声音和与现有通知代理的集成
  • 🖥️ 支持PipeWire和PulseAudio
  • 💾 易于配置重载/保存,包括通过 pwalarmctl 工具

安装

发行版包

我们还没有任何发行版包。如果你想有原生发行版包,请帮助贡献!

手动安装

选项1: Crates.io

使用 cargo 安装

cargo install pwalarmd
cargo install pwalarmctl

选项2: GitHub

克隆仓库

git clone https://github.com/amyipdev/pwalarmd.git

按需进入并运行应用程序

cd pwalarmd
# For pwalarmd
cargo run
# For pwalarmctl
cd pwalarmctl
cargo run -- <options>

或者,安装到系统(未经测试)

cd pwalarmd
cargo install --path .
cd pwalarmctl
cargo install --path .

安装后

你需要配置你的pwalarmd,这包括提供声音资源。

配置

你可以通过设置环境变量 PWALARMD_CONFIG 为路径来设置自定义配置路径。所有路径都应该是 绝对路径,以避免守护进程化问题。否则,pwalarmd 首先查找 ~/.config/pwalarmd/pwalarmd.toml,然后查找 /etc/pwalarmd.toml

如果你正在尝试故障排除或调试,请将 PWALARMD_NODAEMON=0 作为环境变量设置,或者在配置文件中设置 daemon = false

使用方法

运行 pwalarmd 以启动守护进程。

运行 pwalarmctl 以控制它,或修改当前正在使用的配置文件。有关 pwalarmctl 的帮助,请运行 pwalarmctl help

要删除报警,请运行 pwalarmctl list,并注意你想要删除的报警左侧的8个字符;然后你可以运行 pwalarmctl remove N,其中 N 是这些字符,以删除报警。

贡献

对贡献非常欢迎!虽然没有正式的贡献指南,但您可以提交一个Pull Request;我们要求您在提交的最后添加 Signed-off-by: 姓名 <电子邮件> 作为您提交的最后一行。

如果您发现错误或希望添加新功能,请随时提出问题。

限制和已知问题

pwalarmd 在格式错误的包下可能会崩溃。正在努力防止这种情况发生。

许可和致谢

该项目由Amy Parker/amyipdev制作。

版权所有 (C) 2024 Amy Parker,[email protected]

pwalarmd 和 pwalarmctl 使用 GPLv 许可。您可以在 LICENSE 文件中查看许可证。

该项目使用 Rust 构建,并使用几个 Rust 库。您可以在 Cargo.tomlpwalarmctl/Cargo.toml 中看到这些库。

动机

Windows、macOS、iOS 和 Android 都有可用的闹钟子系统。在大多数 Linux 发行版中都没有这种东西。通常没有基于 CLI 的,它们都是 GUI 应用程序;它们通常还要求该 GUI 应用程序始终打开,这不符合许多用例。

依赖项

~3–14MB
~123K SLoC