id       = "remind"
name     = "Remind"
homepage = "https://dianne.skoll.ca/projects/remind/"
description = "A sophisticated reminder service."
executables   = ["remind", "rem"]
platforms = ["macos", "linux"]

[dotfiles]

# The Remind man page documents $HOME/.reminders as the default file (or
# directory) when REMIND_FILE, DOTREMINDERS, and --file are absent.
# https://manpages.debian.org/unstable/remind/remind.1.en.html
paths = ["~/.reminders"]
exclude = []
secret = []

[commands]
format = 1
label = "Show reminders"
description = "Run Remind on a reminder file to print today's reminders, the next occurrence of each, or a calendar. Purge mode, daemon mode, timed-reminder queueing options and variable definitions are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "manual"
kind = "manual"
url = "https://manpages.debian.org/unstable/remind/remind.1.en.html"
revision = "debian unstable 2026-10-27"
evidence = """
  -n
  The -n option causes Remind to print the next
  occurrence of each reminder in a simple calendar format.
  -r
  The -r option disables RUN directives and the shell() function.
  -c[flags]n
  The -c option causes Remind to produce a calendar that is
  sent to standard output. If you supply a number n, then a calendar
  will be generated for n months, starting with the current month.
  -m
  The -m option causes the -c or -p options to produce
  a calendar whose first column is Monday rather than Sunday.
  -v
  The -v option makes the output of Remind slightly more verbose.
  -q
  The -q option causes Remind not to queue timed reminders for later execution.
  -e
  The -e option diverts error messages to the standard output stream.
  --only-todos
  Only issue TODO-type reminders.
  --only-events
  Do not issue TODO-type reminders.
  --json
  In Agenda Mode, output JSON instead of the normal text-mode output.
  --file=filename
"""

[[commands.field]]
id = "file"
label = "Reminder file or directory"
description = "The reminder file or directory to read, given after the options."
type = "path"
position = 0
path = { kind = "any", role = "input" }
sources = ["manual"]

[[commands.field]]
id = "next"
label = "Next occurrence of each reminder"
type = "boolean"
option = ["-n"]
sources = ["manual"]

[[commands.field]]
id = "calendar_months"
label = "Calendar for N months"
description = "Print a formatted calendar for this many months starting with the current month."
type = "integer"
option = ["-c"]
sources = ["manual"]

[[commands.field]]
id = "monday"
label = "Week starts on Monday"
type = "boolean"
option = ["-m"]
sources = ["manual"]

[[commands.field]]
id = "no_run"
label = "Disable RUN and shell()"
type = "boolean"
option = ["-r"]
sources = ["manual"]

[[commands.field]]
id = "no_queue"
label = "Do not queue timed reminders"
type = "boolean"
option = ["-q"]
sources = ["manual"]

[[commands.field]]
id = "verbose"
label = "Verbose"
type = "boolean"
option = ["-v"]
sources = ["manual"]

[[commands.field]]
id = "only_todos"
label = "Only TODO reminders"
type = "boolean"
option = ["--only-todos"]
sources = ["manual"]

[[commands.field]]
id = "only_events"
label = "Only events (no TODOs)"
type = "boolean"
option = ["--only-events"]
sources = ["manual"]

[[commands.field]]
id = "json"
label = "JSON output"
type = "boolean"
option = ["--json"]
sources = ["manual"]

[[commands.task]]
id = "today"
label = "Today's reminders"
fields = ["file", "no_queue", "no_run"]
required = ["file"]
set = { no_queue = [true] }

[[commands.task]]
id = "calendar"
label = "Print a calendar"
fields = ["file", "calendar_months", "monday"]
required = ["file", "calendar_months"]

[[commands.task]]
id = "next_occurrence"
label = "Next occurrence of each reminder"
fields = ["file", "next"]
required = ["file", "next"]
set = { next = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["file", "next", "calendar_months", "monday"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["no_run", "no_queue", "verbose", "only_todos", "only_events", "json"]