Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ducdetronquito/birthday
🎂 CLI tool to remember birthdays of people you know
https://github.com/ducdetronquito/birthday
Last synced: 26 days ago
JSON representation
🎂 CLI tool to remember birthdays of people you know
- Host: GitHub
- URL: https://github.com/ducdetronquito/birthday
- Owner: ducdetronquito
- Created: 2023-12-22T22:03:35.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-02T13:34:46.000Z (11 months ago)
- Last Synced: 2024-11-30T18:49:07.691Z (27 days ago)
- Language: Rust
- Homepage:
- Size: 49.8 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎂 Birthday
CLI tool to remember birthdays of people you know
## Installation
```shell
cargo install birthday
```
## Usage
Birthdays are stored in a SQLite database located in the [standard data directory](https://dirs.dev/)
of your OS, but you can also override this behavior by defining a custom path via the `BIRTHDAY_DATA` environment variable.
### Add someone's birthday
```shell
$ birthday add "Ben Dover" 03 05 1990
$ birthday add "Hugh Jarse" 10 12 1995
$ birthday add "Anita Bath" 22 09 1987
```
### Show all birthdays
```shell
$ birthday all
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may │ 34 (1990) │ today │
│ 3 │ Anita Bath │ 22 september │ 37 (1987) │ 142 days │
│ 2 │ Hugh Jarse │ 10 december │ 29 (1995) │ 221 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```
### Show the next birthday
```shell
$ birthday next
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 2 │ Hugh Jarse │ 10 december │ 29 (1995) │ 221 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```
### Show today's birthdays
```shell
$ birthday today
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may │ 34 (1990) │ today │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```
### Get all birthdays where the name match "Ben"
```shell
$ birthday search --name Ben
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may │ 34 (1990) │ today │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```
### Get all birthdays for a specific year
```shell
$ birthday search --year 1987
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 3 │ Anita Bath │ 22 september │ 37 (1987) │ 142 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```
### Get all birthdays for a specific month
```shell
$ birthday search --month 12
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 2 │ Hugh Jarse │ 10 december │ 29 (1995) │ 221 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```
### Get all birthdays for a specific day
```shell
$ birthday search --month 3
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may │ 34 (1990) │ today │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```
### Forget a birthday by ID
```shell
$ birthday forget 3
Birthday of 'Anita Bath' has been forgotten 🗑️
```