2.7 KiB · text History 1aa586c

PPL

A Rust CLI tool for managing and tracking significant dates for the people in your life.

Features

Just enough to get by.

Storage

Shipping a syncable database for the following information

  • PPL
    • Contact information
    • Tiers
    • Traits
    • Significant Dates
  • Tier Defaults ( Emoji + Color )
  • Trait Defaults ( Emoji + Color )
  • Reminder Configuration

MOTD

Put a message of the day in your bashrc to remind you of important dates. ppl shell [bash|zsh|fish] adds it to your rc file for you (defaults to $SHELL, --print to just show the snippet).

Dates only show up once they’re inside their tier’s reminder window. Set it with ppl tiers set Family 14 (ppl tiers clear Family to remove, ppl tiers to list), or in the TUI’s tiers tab with enter. ppl motd outputs:

motd.png

Reminders

By default reminders will only be shown once per day unless otherwise configured. The options are:

  • OnlyOnce, // Default, Only the first time the motd is run that day`
  • OnceHourly, // Only once per hour, resetting at the top of the hour
  • Randomly(u8), // Will show this motd person randomly u8% every run
  • Always, // Will always show this person’s upcoming
  • Never, // Never show this person’s upcoming

Set the mode per tier with ppl tiers remind Family hourly (daily, hourly, random:30, always, never).

Any of these can be overridden for one person with --person (name, nick or id), e.g. ppl tiers set Family 3 -p Anji, ppl tiers remind Family always -p Anji; ppl tiers clear Family -p Anji goes back to the tier defaults and ppl tiers -p Anji shows what applies.

In the TUI the same keys work on the tiers tab (defaults) and on a selected tier while editing a person (overrides): m cycles the mode, +/- change the window, [/] change the random %, x clears.

TUI

A Terminal UI for managing all the various stored information in the database.

Default View

PPL List, shows all configured ppl, their tiers, traits and information

Press e to edit the selected person; the 👤 row at the top edits their name and nickname (the nickname is what the list, calendar and motd show). From the CLI: ppl edit Anjali --nick Anji, --name to rename, --nick "" to clear.

default.png

Calendar View

Upcoming Anniversaries

calendar.png

Tier View

Add and Modify Tiers and Defaults

tiers.png

Trait View

Add and Modify Traits and Defaults

img.png

Stats

ppl stats shows a summary of the current database

Tiers & Traits

ppl tiers and ppl traits list all the tiers and traits in the database