rusday

rusday is a command line application intended to help you remember your friends' birthdays. I primarly made this project to learn Rust, but also because I've got to known a couple of awesome people through programming over the past couple months and wanted to ensure that I don't forget their birthdays. One may argue about the practical use of this, but I like to think that it's a nice thing.

Installation

Installation is easy thanks to cargo:

$ cargo install --git https://github.com/jchristgit/rusday

Now, you're free to use rusday, given that you have cargo's bin directory in your $PATH.

Usage

rusday help should give you a basic idea of how to use it. The basic workflow is simple: Use rusday add and rusday remove to add and remove people, then use rusday list to get an overview for all the entries. You can use rusday dashboard to only be informed about who's birthday it is. I sticked that into my ~/.bash_login to ensure I get informed about anyone's birthday when I open my Terminal.

rusday 0.6.1
A CLI tool to help you remember your friends' birthdays.

USAGE:
    rusday [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --color <color>    when to use colored / formatted output [default: auto]  [values: auto, always, never]

SUBCOMMANDS:
    add          Adds someone to the database.
    dashboard    Shows a dashboard with the most relevant information.
    help         Prints this message or the help of the given subcommand(s)
    list         Shows a list of people in the database.
    remove       Remove someone from the database.

Commands

• rusday help gives the expected output showing the other commands.
• rusday add <DATE> <NAME> is used to add someone to the database. <DATE> is expected to be in the format dd-mm-yyyy, but this can be customized with the date_fmt argument. See rusday add --help for details.
• rusday remove <NAME> is used to remove someone from the database. It checks for an exact match of the name.
• rusday list shows you everyone that's currently in the database, sorted by their birthdate.
• rusday dashboard shows you who's birthday is on the current date.

Have an idea for a command? Open an issue and let me know!

Configuration

It's possible to configure the database path that rusday uses by setting the environment variable RUSDAY_DB_PATH. In case this isn't set, rusday will uses dirs::data_dir to determine where to store its database file.