Commands

Quick Start

Here are the bare minimum commands you need to get started

  • cali add "reminder" 1/4 or cali add "reminder" jan 4
  • cali all

Add

Use: Adds a reminder
Format: cali add "[reminder]" [date]Dates can be written in a variety of formats:

  • 1. month/day/yearEx. 1/20/2021 or 1/20 (year is optional)
  • 2. Month Day YearEx. Jan 20 2021 or Jan 20 (year is optional)
  • 3. in [w]d [x]w [y]m [z]yEx. in 5d 1w 2m 1y = in 5 days, 1 week, 2 months, and 1 year from now (all are optional)

$ cali add "Final group meeting" 1/14
$ cali add "Final group meeting" 1/14/2021
$ cali add "Final group meeting" Jan 14
$ cali add "Final group meeting" January 14
$ cali add "Final group meeting" in 3d 1w

All

Use: Displays all reminders
Format: cali all

$ cali all
~ Today is January 4th (1/4)
~ 1. Turn in essay
~
~ Upcoming
~ 2. Final group meeting - in 10 days (1/14)
~ 3. Bday party - in 17 days (1/21)

Today

Use: Displays today's reminders
Format: cali today

$ cali today
~ Reminders for today, January 4th (1/4)
~ 1. Turn in essay

List

Use: Displays all reminders on a specific day
Format: cali list [date]

  • Dates can be of any format shown in the Add section
  • Ex. cali list 1/25, cali list jan 25, cali list in 5d

$ cali list 1/21
$ cali list jan 21
$ cali list in 17d
~ Reminders for January 21st (1/21)
~ Bday party

Del

Use: Deletes a reminder
Format: cali del [index]...

  • The index is the number next to a reminder when displayed with cali all
  • Type multiple space-separated indexes to delete multiple reminders at a time
  • Or use cali del all to delete all reminders

$ cali all
~ Today is January 4th (1/4)
~ 1. Turn in essay
~
~ Upcoming
~ 2. Final group meeting - in 10 days (1/14)
~ 3. Bday party - in 17 days (1/21)
~
$ cali del 1 2
~ Deleted reminder: Turn in essay
~ Deleted reminder: Final group meeting

Set

Use: Configures CLI settings such as text color and notification properties
Format: cali set --subtitle=[color] --success=[color] --error=[color] --audio=[audio] --duration=[duration]

  • cali set with no flags displays current settings
  • cali set default resets all configurations to their default value
  • All flags are optional
  • --subtitle: sets the subtitle text color
  • --success: sets the success text color
  • --error: sets the error text color
  • --audio: sets the notification sound
  • --duration: sets the notification duration
  • Valid color options: default, black, blue, cyan, green, magenta, red, white, yellow, or none
  • Valid audio options: default, fancy, or none
  • Valid duration options: short or long

$ cali set --subtitle=magenta --success=blue --error=yellow --audio=fancy --duration=long
~
$ cali set
~ Current Settings
~ subtitle: magenta
~ success: blue
~ error: yellow
~ audio: fancy
~ duration: long

Notify

Use: Sends a system notification about your reminders
Format: cali notify

  • Mainly just used for testing purposes

$ cali notify

--Help Flag

Use: Displays information/examples about any comamnd
Format: cali [command] --help

$ cali add --help
~ Adds a reminder
~
~ Usage:
~ cali add [reminder] [date] [flags]
~
~ Examples:
~ cali add "Turn in essay" 4/29
~ cali add "Turn in essay" 4/29/2022
~ cali add "Turn in essay" Apr 29
~ cali add "Turn in essay" in 2d
~ cali add "Turn in essay" in 1d 2w 3m 1y