id       = "jackett"
name     = "Jackett"
homepage = "https://github.com/Jackett/Jackett"
description = "API Support for your favorite torrent trackers."
executables   = ["jackett"]

[dotfiles]

# Jackett's official README (https://github.com/Jackett/Jackett) identifies
# ~/.config/Jackett/ as the Linux location and lists
# ~/Library/Application Support/Jackett/ as a macOS location. ServerConfig.json
# is the user configuration file and contains the Jackett API/admin secrets;
# the Windows location in that README is %ProgramData% (system-wide), so it is
# intentionally outside this user dotfile catalog.
paths = []
secret = [
  "~/.config/Jackett/ServerConfig.json",
  "~/Library/Application Support/Jackett/ServerConfig.json",
]

[commands]
format = 1
label = "Start Jackett"
description = "Start the Jackett server in the foreground with common switches. Windows service management switches (install, start, stop, uninstall, reserve URLs) are not covered."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "readme"
kind = "manual"
url = "https://raw.githubusercontent.com/Jackett/Jackett/master/README.md"
revision = "master 2026-10-27"
evidence = """
- `-l, --Logging` - Log all requests/responses to Jackett
- `-t, --Tracing` - Enable tracing
- `-x, --ListenPublic` - Listen publicly (accessible from other devices)
- `-z, --ListenPrivate` - Only allow local access (default)
- `-p, --Port` - Specify web server port (default: 9117)
- `-d, --DataFolder` - Specify the location of the data folder (requires administrator on Windows)
- `--NoRestart` - Don't restart after update
- `--PIDFile` - Specify the location of the PID file
- `--NoUpdates` - Disable automatic updates
"""

[[commands.field]]
id = "port"
label = "Web server port"
description = "Defaults to 9117."
type = "integer"
option = ["--Port", "-p"]
sources = ["readme"]

[[commands.field]]
id = "listen_public"
label = "Listen publicly"
description = "Make the web UI reachable from other devices."
type = "boolean"
option = ["--ListenPublic", "-x"]
sources = ["readme"]

[[commands.field]]
id = "logging"
label = "Log all requests/responses"
type = "boolean"
option = ["--Logging", "-l"]
sources = ["readme"]

[[commands.field]]
id = "tracing"
label = "Tracing"
type = "boolean"
option = ["--Tracing", "-t"]
sources = ["readme"]

[[commands.field]]
id = "no_updates"
label = "Disable automatic updates"
type = "boolean"
option = ["--NoUpdates"]
sources = ["readme"]

[[commands.field]]
id = "no_restart"
label = "No restart after update"
type = "boolean"
option = ["--NoRestart"]
sources = ["readme"]

[[commands.field]]
id = "pid_file"
label = "PID file"
type = "path"
option = ["--PIDFile"]
path = { kind = "file", role = "output", must_exist = false }
effect = "overwrite"
sources = ["readme"]

[[commands.field]]
id = "data_folder"
label = "Data folder"
description = "The README advises against this on Unix; set HOME or XDG_CONFIG_HOME instead."
type = "path"
option = ["--DataFolder", "-d"]
path = { kind = "directory", role = "input" }
sources = ["readme"]

[[commands.task]]
id = "start"
label = "Start on a port"
fields = ["port", "listen_public", "no_updates"]
required = []

[[commands.task]]
id = "debug"
label = "Start with detailed logging"
fields = ["port", "logging", "tracing"]
required = []
set = { logging = [true], tracing = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["port", "listen_public", "logging", "tracing"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["no_updates", "no_restart", "pid_file", "data_folder"]