id       = "nom"
name     = "nom"
homepage = "https://github.com/guyfedwards/nom"
description = "RSS reader for the terminal."
executables   = ["nom"]

[dotfiles]

# nom's source uses os.UserConfigDir()/nom/config.yml by default, with an
# XDG_CONFIG_HOME override when that file exists. The README documents the
# adjacent SQLite store; it is state and is excluded below.
# https://github.com/guyfedwards/nom/blob/master/internal/config/config.go
# https://github.com/guyfedwards/nom#store
paths = [
  "[configHome]/nom/config.yml",
  "[appData]/nom/config.yml",
  "%APPDATA%/nom/config.yml",
]
exclude = [
  "[configHome]/nom/nom.db",
  "[appData]/nom/nom.db",
  "%APPDATA%/nom/nom.db",
]
secret = []

# Backend API keys and FreshRSS passwords are fields inside the otherwise
# useful YAML configuration; preserve the rest while treating these values as
# credentials.
[[dotfiles.secret_paths]]
file  = ["[configHome]/nom/config.yml", "[appData]/nom/config.yml", "%APPDATA%/nom/config.yml"]
match = { key_path = ["backends.miniflux.*.api_key", "backends.freshrss.*.password"] }

[commands]
format = 1
label = "nom"
description = "Start the RSS reader with an optional config file, or add a feed. OPML import is left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "readme"
kind = "help"
url = "https://raw.githubusercontent.com/guyfedwards/nom/HEAD/README.md"
revision = "HEAD 2026-10-27"
evidence = """nom -c my-custom-config.yml
nom # start TUI
nom add <url>
nom add [-n <name>] [-t tag [...]] <url>"""

[[commands.field]]
id = "config"
label = "Config file"
description = "Use a custom config file instead of the default one."
type = "path"
option = ["-c"]
path = { kind = "file", role = "input" }
sources = ["readme"]

[[commands.task]]
id = "tui"
label = "Start reader"
fields = ["config"]
required = []

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["config"]

[[commands.subcommand]]
path = ["add"]
label = "Add a feed"
description = "Add a feed URL to the configuration, optionally with a name and tags."

[[commands.subcommand.source]]
id = "readme"
kind = "help"
url = "https://raw.githubusercontent.com/guyfedwards/nom/HEAD/README.md"
revision = "HEAD 2026-10-27"
evidence = """nom add [-n <name>] [-t tag [...]] <url>"""

[[commands.subcommand.field]]
id = "name"
label = "Feed name"
type = "string"
option = ["-n"]
sources = ["readme"]

[[commands.subcommand.field]]
id = "tag"
label = "Tags"
type = "string"
option = ["-t"]
multiple = true
sources = ["readme"]

[[commands.subcommand.field]]
id = "url"
label = "Feed URL"
type = "url"
position = 0
sources = ["readme"]

[[commands.subcommand.task]]
id = "add"
label = "Add feed"
fields = ["url", "name", "tag"]
required = ["url"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["url", "name", "tag"]