Skip to content

CLI app for describing and reminding what you must do today

License

Notifications You must be signed in to change notification settings

vncsmyrnk/todayiwill

Repository files navigation

todayiwill

CI workflow Release workflow Rust codecov GitHub Actions contributions Issue count

A CLI reminder app that offers a simple yet powerful solution to enhance productivity and ensure that you stay on top of your daily responsibilities. Unlike complex project management tools, a CLI app provides a lightweight and straightforward interface that integrates seamlessly into the workflows of developers, system administrators, and tech-savvy users who spend a significant portion of their day in the terminal.

gif demonstrating the utilization

🚀 Examples

Documentation

$ todayiwill
A CLI for remembering what you need to do today.
Checkout the project on https://github.com/vncsmyrnk/todayiwill for submitting requests and rating the app.

Usage: todayiwill [OPTIONS] <COMMAND>

Commands:
  add      Add appointment for today
  copy     Copies the appointments from a specific date to today
  clear    Clear all the appointments added for today
  list     List the appointments to come for today
  history  List the appointments for other days
  remove   Removes a future appointment
  help     Print this message or the help of the given subcommand(s)

Options:
  -c, --current-time <HH:MM>  Current time, defaults to system time [default: 23:59]
  -h, --help                  Print help
  -V, --version               Print version

Add appointments

$ todayiwill add --description "Take my dog to the vet" --time "14:00"
Appointment added successfully
$ echo "19:30 Wash the dishes" | todayiwill add --stdin
Appointment added successfully

List appointments

$ todayiwill list
[14:00] Take my dog to the vet

💽 Install

gif showing the installation process

All packages are made to x86_64 architecture.

Ubuntu/debian (bash)

bash <(wget -O- https://github.com/vncsmyrnk/todayiwill/releases/latest/download/install-linux-debian.sh 2> /dev/null)

Ubuntu/debian (deb package)

curl -L -O https://github.com/vncsmyrnk/todayiwill/releases/latest/download/todayiwill_0.6.0_amd64.deb # or other version
sudo apt install ./todayiwill_0.6.0_amd64.deb

Homebrew

brew tap vncsmyrnk/todayiwill https://github.com/vncsmyrnk/todayiwill.git
brew install vncsmyrnk/todayiwill/app

Arch

curl  -L -O https://github.com/vncsmyrnk/todayiwill/releases/latest/download/PKGBUILD
makepkg -si

🪄 Coming soon...

Check the opened issues section to know what will soon be available.

Access the closed PR section to know what was done so far.

🗑 Uninstall

Ubuntu/debian

bash <(wget -O- https://github.com/vncsmyrnk/todayiwill/releases/latest/download/uninstall-linux-debian.sh 2> /dev/null)

🔧 Development with docker

docker run --rm -it \
    -v "$(pwd)":/home/dev/app \
    -v ~/.ssh:/home/dev/.ssh \
    -e GIT_USERNAME="$(git config --list | grep "user.name" | cut -d = -f2)" \
    -e GIT_EMAIL="$(git config --list | grep "user.email" | cut -d = -f2)" \
    -u dev \
    --cpus 2 \
    --workdir /home/dev/app \
    ghcr.io/vncsmyrnk/rust-dev:latest bash

Documentation

Go to docs for checking out the code documentation.

Dev Tools

Once inside the container, you can run $ sudo -E ./dev-setup.sh to install dev dependencies like git and nvim.