id       = "tailspin"
name     = "tailspin"
homepage = "https://github.com/bensadeh/tailspin"
description = "A log file highlighter."
executables   = ["tspin"]

[dotfiles]

# tailspin's upstream README documents a user theme at ~/.config/tailspin/
# theme.toml and the Windows spelling %APPDATA%/tailspin/theme.toml. The
# TAILSPIN_THEME option is an explicit override and has no fixed location.
# https://github.com/bensadeh/tailspin#customizing-highlight-groups
paths = [
  "[configHome]/tailspin/theme.toml",
  "%APPDATA%/tailspin/theme.toml",
]
exclude = []
secret = []
side_effect = false

[commands]
format = 1
label = "Highlight a log file"
description = "View a log file (or a command's output) with highlighting in a pager. Highlight-group selection and shell completions are 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://github.com/bensadeh/tailspin#settings"
revision = "2026-10-27"
evidence = """
-f, --follow                     Follow the contents of the file
-p, --print                      Print the output to stdout
-e, --exec='[CMD]'               Run command and view the output in a pager
    --theme=[PATH]               Use the theme file from the provided path
    --pager=[CUSTOM_PAGER]       Set a custom pager
    --highlight=[COLOR]:[WORDS]  Highlight the provided comma-separated words in the specified color
"""

[[commands.field]]
id = "file"
label = "Log file"
type = "path"
position = 0
path = { kind = "file", role = "input" }
sources = ["readme"]

[[commands.field]]
id = "follow"
label = "Follow file"
type = "boolean"
option = ["--follow", "-f"]
sources = ["readme"]

[[commands.field]]
id = "print"
label = "Print to stdout"
type = "boolean"
option = ["--print", "-p"]
sources = ["readme"]

[[commands.field]]
id = "exec"
label = "Run command and view its output"
type = "string"
option = ["--exec", "-e"]
sources = ["readme"]

[[commands.field]]
id = "theme"
label = "Theme file"
type = "path"
option = ["--theme"]
path = { kind = "file", role = "input" }
sources = ["readme"]

[[commands.field]]
id = "pager"
label = "Custom pager"
type = "string"
option = ["--pager"]
sources = ["readme"]

[[commands.field]]
id = "highlight"
label = "Highlight words"
description = "Format COLOR:WORD,WORD, for example red:ERROR,WARNING."
type = "string"
option = ["--highlight"]
multiple = true
sources = ["readme"]

[[commands.task]]
id = "view"
label = "View a log file"
fields = ["file"]
required = ["file"]

[[commands.task]]
id = "follow"
label = "Follow a log file"
fields = ["file", "follow"]
required = ["file"]
set = { follow = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["file", "follow", "print", "exec"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["theme", "pager", "highlight"]