https://github.com/fcanas/dit
Basic CLI for Reminders on macOS
https://github.com/fcanas/dit
cli-app macos reminder-application
Last synced: about 1 month ago
JSON representation
Basic CLI for Reminders on macOS
- Host: GitHub
- URL: https://github.com/fcanas/dit
- Owner: fcanas
- License: apache-2.0
- Created: 2020-07-02T20:23:01.000Z (almost 6 years ago)
- Default Branch: canon
- Last Pushed: 2022-01-25T02:42:58.000Z (over 4 years ago)
- Last Synced: 2025-03-29T06:02:22.740Z (about 1 year ago)
- Topics: cli-app, macos, reminder-application
- Language: Swift
- Homepage:
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# dit
A command line interface for Reminders on macOS.
dit is not complete, and its structure would have to change substantially to become complete.
* See existing Lists
* Query Reminders in those lists
- filtering by completion status
- for due date in open or closed time ranges
- for completion date in open or closed time ranges
* Create Reminders
- in arbitrary lists
- in a default list
- with a due date specified as an interval from today
- with a recurrence specified as an time interval[‡](#recurrence)
* Mark reminders as done/undone
## Installing
The `dit` CLI tool is available via a [Homebrew](https://brew.sh) [tap](https://docs.brew.sh/Taps#the-brew-tap-command):
`brew install fcanas/tap/dit`
or
```
brew tap fcanas/tap
brew install dit
```
## Documentation
### `dit`
```
OVERVIEW: Manipulate reminders
USAGE: dit
OPTIONS:
--version Show the version.
-h, --help Show help information.
SUBCOMMANDS:
query (default) Show Reminders.
create Create a new reminder.
lists Display Lists of Reminders
configure Configure default settings.
do Mark reminders as done.
See 'dit help ' for detailed help.
```
### `dit query`
```
OVERVIEW: Show Reminders.
Date filters --starting and --ending operate on the due date for
incomplete tasks and the completion date for complete tasks.
USAGE: dit query [--all] [--complete] [--incomplete] [--list ] [--starting ] [--ending ]
OPTIONS:
--all/--complete/--incomplete
Show Reminders based on completion status. (default: incomplete)
-l, --list The name of the list to query. Default can be set with the
configure command.
-s, --starting
Beginning of time range to query within, specified relative to
today. e.g. 2d specifies to search for Reminders
beginning two days from now.
-e, --ending End of time range to query within, specified relative to today.
e.g. 3w specifies to search for Reminders before three
weeks from now.
--version Show the version.
-h, --help Show help information.
```
### `dit create`
```
OVERVIEW: Create a new reminder.
USAGE: dit create [--list ] [--due-in ] [--repeats ]
ARGUMENTS:
Title for the new reminder
OPTIONS:
-l, --list The list to create the reminder in
-d, --due-in An interval specifying how far from now the reminder is due,
specified in minutes, hours, days,
weeks, months, and years. These units
can be combined in ascending order, e.g. 1y2m17h22s
-r, --repeats How often the reminder should repeat, in days,
weeks, months, and years. These units
cannot be comined. e.g. 3w, y, d,
24d
--version Show the version.
-h, --help Show help information.
```
‡ Recurrence intervals can currently only be made in the form of "Every _N_ ( days | weeks | months | years )"
### `dit lists`
```
OVERVIEW: Display Lists of Reminders
USAGE: dit lists
OPTIONS:
--version Show the version.
-h, --help Show help information.
```
### `dit configure`
```
OVERVIEW: Configure default settings.
USAGE: dit configure [--default-list ]
OPTIONS:
-d, --default-list
Set the default List when creating a reminder
--version Show the version.
-h, --help Show help information.
```
### `dit do`
```
OVERVIEW: Mark reminders as done.
Do is an interactive command.The flags and options form a query, and present a numbered
list of items that can be selected for toggling. Date filters --starting and
--ending operate on the due date for incomplete tasks and the completion date for
complete tasks.
USAGE: dit do [--all] [--complete] [--incomplete] [--list ] [--starting ] [--ending ]
OPTIONS:
--all/--complete/--incomplete
Show Reminders based on completion status. (default: incomplete)
-l, --list The name of the list to query. Default can be set with the
configure command.
-s, --starting
Beginning of time range to query within, specified relative to
today. e.g. 2d specifies to search for Reminders
beginning two days from now.
-e, --ending End of time range to query within, specified relative to today.
e.g. 3w specifies to search for Reminders before three
weeks from now.
--version Show the version.
-h, --help Show help information.
```