5 unstable releases
0.3.2 | Jul 13, 2022 |
---|---|
0.3.1 | Jul 13, 2022 |
0.3.0 | Jul 7, 2022 |
0.2.0 | Jul 7, 2022 |
0.1.0 | Jun 27, 2022 |
#58 in #sending
22KB
271 lines
Recollection
Notify you for daily, weekly, monthly and yearly events.
Usage
Use recollectctl
to manage the events, and run recollectd
daemon to monitor the
events and send notifications.
Before running recollectd
, please execute recollectctl init
to initialize the
data file or recollectctl new
to create an event, otherwise the daemon will fail.
For more information, please run
recollectctl help
# and
recollectd help
Systemd
A sample systemd service file can be found in misc/recollectd.service
. For
per-user use, you may install the file to $HOME/.config/systemd/user/
. For
system-wide use, install the file to /etc/systemd/system/
instead. Edit the file
and specify the path to your installed recollectd
binary before starting the
service.
[Service]
...
ExecStart=/your/path/to/recollectd
Install
You can install from <crates.io> using cargo
cargo install --locked recollectctl recollectd
Or, build from source
cargo install --git=https://factoria.origincode.me/OriginCode/recollection.git
Requirements
Build
rustc
1.58 or higher- Cargo
Runtime
- See https://github.com/hoodie/notify-rust#readme for more information.
Structure
- librecollect: Library for parsing events and utilities to control the storage
- recollectd: Daemon to monitor the events and send notifications
- recollectctl: Command line interface for managing the events
Dependencies
~8–37MB
~560K SLoC