https://github.com/mufeez-amjad/avail
Find available times between all your calendars
https://github.com/mufeez-amjad/avail
calendar cli
Last synced: 16 days ago
JSON representation
Find available times between all your calendars
- Host: GitHub
- URL: https://github.com/mufeez-amjad/avail
- Owner: mufeez-amjad
- License: mit
- Created: 2022-09-14T20:02:34.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T21:20:34.000Z (almost 3 years ago)
- Last Synced: 2024-04-20T16:59:50.040Z (over 1 year ago)
- Topics: calendar, cli
- Language: Rust
- Homepage:
- Size: 264 MB
- Stars: 45
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-cli-apps-in-a-csv - avail - Find available times between all your calendars. (<a name="organizers"></a>Organizers and calendars)
- awesome-cli-apps - avail - Find available times between all your calendars. (<a name="organizers"></a>Organizers and calendars)
README
# avail [](https://github.com/mufeez-amjad/avail/actions/workflows/build.yml)
avail is a cli tool that helps you find available times between all your calendars.
### Features
- Search for availabilities:
- with a specific duration (e.g. one hour)
- within a search window (e.g. between start and end date, or 1 week out)
- during specific hours of the day (e.g. 12pm onwards)
- across any number of calendars associated with a Google or Microsoft account
- Create hold events so you don't double book yourself
- Copies formatted availability to system clipboard
## Installation
The easiest way to install `avail` is by running the following command:
```bash
curl -fsSL https://raw.githubusercontent.com/mufeez-amjad/avail/master/install.sh | sh -
```
Alternatively, you can install `avail` by [building from source](https://github.com/mufeez-amjad/avail/wiki/Getting-Started#from-source) or [installing a pre-built binary](https://github.com/mufeez-amjad/avail/wiki/Getting-Started#pre-built-binary).
After installing, you will then need to retrieve OAuth credentials for Microsoft Outlook, Google Calendar, or both. Instructions can be found [here](https://github.com/mufeez-amjad/avail/wiki/Getting-Started#setting-up-oauth).
## Usage
```
Usage: avail [OPTIONS] [COMMAND]
Commands:
accounts Manages OAuth accounts (Microsoft Outlook and Google Calendar)
calendars Allows specifying which calendars to use when querying, refreshes calendar cache for added accounts
help Print this message or the help of the given subcommand(s)
Options:
--start Start of search window in the form of MM/DD/YYYY (default now)
--end End of search window in the form of MM/DD/YYYY (default start + 7 days)
--min Minimum time for availability in the form of :am/pm (default 9:00am)
--max Maximum time for availability in the form of :am/pm (default 5:00pm)
-w, --window Duration of search window, specify with (w|d|h|m) (default 1w)
--include-weekends Option to include weekends in availability search (default false)
-d, --duration Duration of availability window, specify with (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
```
More information on the commands is available in the [wiki](https://github.com/mufeez-amjad/avail/wiki/Commands#avail).
## Examples
Find 30 minute blocks of availability between 9:00am and 5:00pm from now until one week from now:
```
avail
```
Find 1 hour blocks of availability between 10:00am and 4:00pm from 01/01/2022 until 01/31/2022:
```bash
avail --start 01/01/2022 --end 01/31/2022 --min 10:00am --max 4:00pm --duration 1h
```
Find 2 hour blocks of availability between 9:00am and 5:00pm including weekends from now until 2 weeks from now:
```bash
avail --window 2w --include-weekends --duration 2h
```
## Contributing
Feel free to open a PR!
## License
avail is licensed under the [MIT License](./LICENSE.md).