id       = "newsboat"
name     = "Newsboat"
homepage = "https://newsboat.org/"
description = "RSS/Atom feed reader for text terminals."
executables   = ["newsboat", "podboat"]

[dotfiles]

# https://newsboat.org/releases/2.42/docs/newsboat.html — config and urls
# live in ~/.newsboat for the legacy layout; current releases use
# $XDG_CONFIG_HOME/newsboat when that directory exists. Feed URLs can embed
# HTTP credentials, so both urls files are secret while config remains syncable.
paths = ["~/.newsboat/config", "[configHome]/newsboat/config"]
secret = ["~/.newsboat/urls", "[configHome]/newsboat/urls"]

[commands]
format = 1
label = "Run newsboat"
description = "Start newsboat with an alternate URL file, cache or config, import or export OPML, or refresh on start. Log, read-article transfer and cache maintenance options are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "help"
kind = "manual"
url = "https://newsboat.org/releases/2.42/docs/newsboat.html"
revision = "2.42"
evidence = """
usage: ./newsboat [-i <file>|-e] [-u <urlfile>] [-c <cachefile>] [-x <command> ...] [-h]
    -e, --export-to-opml            export OPML feed to stdout
    -r, --refresh-on-start          refresh feeds on start
    -i, --import-from-opml=<file>   import OPML file
    -u, --url-file=<urlfile>        read RSS feed URLs from <urlfile>
    -c, --cache-file=<cachefile>    use <cachefile> as cache file
    -C, --config-file=<configfile>  read configuration from <configfile>
    -q, --quiet                     quiet startup
"""

[[commands.field]]
id = "url_file"
label = "URL file"
type = "path"
path = { kind = "file", role = "input" }
option = ["--url-file", "-u"]
sources = ["help"]

[[commands.field]]
id = "cache_file"
label = "Cache file"
type = "path"
path = { kind = "file", role = "output" }
option = ["--cache-file", "-c"]
sources = ["help"]

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

[[commands.field]]
id = "refresh"
label = "Refresh feeds on start"
type = "boolean"
option = ["--refresh-on-start", "-r"]
sources = ["help"]

[[commands.field]]
id = "quiet"
label = "Quiet startup"
type = "boolean"
option = ["--quiet", "-q"]
sources = ["help"]

[[commands.field]]
id = "import_opml"
label = "Import OPML file"
type = "path"
path = { kind = "file", role = "input" }
option = ["--import-from-opml", "-i"]
sources = ["help"]

[[commands.field]]
id = "export_opml"
label = "Export OPML to stdout"
type = "boolean"
option = ["--export-to-opml", "-e"]
sources = ["help"]

[[commands.task]]
id = "start"
label = "Start and refresh"
fields = ["refresh", "url_file", "config_file", "quiet"]
required = []
set = { refresh = [true] }

[[commands.task]]
id = "import"
label = "Import OPML"
fields = ["import_opml"]
required = ["import_opml"]

[[commands.task]]
id = "export"
label = "Export OPML"
fields = ["export_opml"]
required = ["export_opml"]
set = { export_opml = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["refresh", "quiet", "url_file", "config_file", "cache_file", "import_opml", "export_opml"]