Skip to content

Commands

Mufeez Amjad edited this page Dec 27, 2022 · 3 revisions

avail

Usage: avail [OPTIONS]

Options:
      --start <START>        Start of search window in the form of MM/DD/YYYY (default now)
      --end <END>            End of search window in the form of MM/DD/YYYY (default start + 7 days)
      --min <MIN>            Minimum time for availability in the form of <int>:<int>am/pm (default 9:00am)
      --max <MAX>            Maximum time for availability in the form of <int>:<int>am/pm (default 5:00pm)
  -w, --window <WINDOW>      Duration of search window, specify with <int>(w|d|h|m) (default 1w)
      --include-weekends     Option to include weekends in availability search (default false)
  -d, --duration <DURATION>  Duration of availability window, specify with <int>(w|d|h|m) (default 30m)
  -c, --create-hold-event    Create a hold event (default false)
  -h, --help                 Print help information
  -V, --version              Print version information

avail accounts

add

Usage: avail accounts add <EMAIL>

Arguments:
  <EMAIL>  The email of the account

This command adds an account to avail.

When running this command, you will have the option to choose between adding a Microsoft Outlook or Google Calendar account. After selecting an account, your web browser will launch and ask you to sign in through OAuth. After signing in, avail receives your OAuth access token and the account is successfully added.

Your OAuth access token is stored in the underlying platform secure store (e.g Keychain for MacOS). If you receive a popup asking for keychain access, select "Always Allow" to not be asked again.

Note: after adding an account, you must run avail calendars to update the calendars cache.

remove

Usage: avail accounts remove <EMAIL>

Arguments:
  <EMAIL>  The email of the account to remove

This command removes the account and its associated calendars from avail.

list

Usage: avail accounts list

This command lists all of the accounts connected to avail.

avail calendars

Usage: avail calendars

This command refreshes the calendars cache and allows you to select which calendars to use when determining availability and which calendar to use when creating hold events.