id          = "alot"
name        = "Alot"
homepage    = "https://alot.readthedocs.io/"
description = "Alot is a terminal-based mail user agent for the notmuch mail system."
executables = ["alot"]
platforms   = ["macos", "linux"]

[dotfiles]

# The official settings reference names the user files ~/.config/alot/config,
# ~/.config/alot/hooks.py and ~/.mailcap.  The configuration reference also
# places user templates and themes below $XDG_CONFIG_HOME/alot, represented by
# the XDG [configHome] root here.
# https://alot.readthedocs.io/en/latest/api/settings.html
# https://alot.readthedocs.io/en/latest/configuration/
paths = [
  "~/.config/alot/config",
  "~/.config/alot/hooks.py",
  "[configHome]/alot/themes/",
  "[configHome]/alot/templates/",
  "~/.mailcap",
]

# Account settings identify the notmuch database and invoke the user's
# sendmail command; Alot delegates credentials to that mail system rather than
# documenting a password file of its own.
secret = []
side_effect = false

[commands]
format = 1
label = "Start alot"
description = "Open alot, optionally with a search query or compose. Debug-level and log options are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = true }

[[commands.source]]
id = "manpage"
kind = "manual"
url = "https://manpages.debian.org/unstable/alot/alot.1.en.html"
revision = "0.12-3"
evidence = """
alot [options …] [subcommand]
-r, --read-only
open notmuch database in read-only mode
-c FILENAME, --config=FILENAME
configuration file (default: ~/.config/alot/config)
-n FILENAME, --notmuch-config=FILENAME
notmuch configuration file (default: see notmuch-config(1))
-C COLOURS, --colour-mode=COLOURS
number of colours to use on the terminal; must be 1, 16 or 256
-p PATH, --mailindex-path=PATH
path to notmuch index
search
start in a search buffer using the query string provided as parameter
compose
compose a new message
bufferlist
taglist
namedqueries
"""

[[commands.field]]
id = "read_only"
label = "Read-only database"
type = "boolean"
option = ["--read-only", "-r"]
sources = ["manpage"]

[[commands.field]]
id = "config"
label = "Config file"
type = "path"
path = { kind = "file", role = "input" }
option = ["--config", "-c"]
sources = ["manpage"]

[[commands.field]]
id = "notmuch_config"
label = "Notmuch config file"
type = "path"
path = { kind = "file", role = "input" }
option = ["--notmuch-config", "-n"]
sources = ["manpage"]

[[commands.field]]
id = "colour_mode"
label = "Colours"
type = "enum"
choices = [{ value = "1", label = "1" }, { value = "16", label = "16" }, { value = "256", label = "256" }]
option = ["--colour-mode", "-C"]
sources = ["manpage"]

[[commands.field]]
id = "mailindex_path"
label = "Notmuch index path"
type = "path"
path = { kind = "directory", role = "input" }
option = ["--mailindex-path", "-p"]
sources = ["manpage"]

[[commands.field]]
id = "subcommand"
label = "Start in"
type = "enum"
choices = [{ value = "search", label = "Search" }, { value = "compose", label = "Compose" }, { value = "bufferlist", label = "Buffer list" }, { value = "taglist", label = "Tag list" }, { value = "namedqueries", label = "Named queries" }]
position = 0
sources = ["manpage"]

[[commands.field]]
id = "query"
label = "Search query"
description = "Only used with Start in = Search."
type = "string"
position = 1
sources = ["manpage"]

[[commands.task]]
id = "search"
label = "Search mail"
fields = ["subcommand", "query"]
required = ["subcommand", "query"]
set = { subcommand = ["search"] }

[[commands.task]]
id = "read_only"
label = "Browse read-only"
fields = ["read_only"]
required = ["read_only"]
set = { read_only = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["subcommand", "query", "read_only"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["config", "notmuch_config", "colour_mode", "mailindex_path"]