id       = "jiratui"
name     = "JiraTUI"
homepage = "https://github.com/whyisdifficult/jiratui"
description = "A terminal user interface for Jira."
executables   = ["jiratui"]

[dotfiles]

# JiraTUI's README says it loads $XDG_CONFIG_HOME/jiratui/config.yaml, or
# $HOME/.config/jiratui/config.yaml when XDG_CONFIG_HOME is unset. An explicit
# JIRA_TUI_CONFIG_FILE is intentionally not listed because it has no fixed path.
# https://github.com/whyisdifficult/jiratui/blob/main/README.md#authoring-the-config-file-manually
paths = ["[configHome]/jiratui/config.yaml"]

exclude = []
secret = []
side_effect = false

# The same README requires jira_api_token in this YAML file for API access;
# only the token is extracted, while the URL and username remain preferences.
[[dotfiles.secret_paths]]
file  = "[configHome]/jiratui/config.yaml"
match = { key_path = ["jira_api_token"] }

[commands]
format = 1
label = "JiraTUI"
description = "Search Jira work items from the command line. The interactive UI and configuration commands take no options worth a form."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand]]
path = ["issues", "search"]
label = "Search work items"
description = "Search by project key or by a single issue key (both case-sensitive). Other filters are left out."

[[commands.subcommand.source]]
id = "readme"
kind = "manual"
url = "https://github.com/whyisdifficult/jiratui/blob/main/README.md"
revision = "2026-10-27"
evidence = """
To search for work items in the project `SCRUM`, use the issues search command and pass the `--project-key` argument with the (case-sensitive) project key.
$ jiratui issues search --project-key SCRUM
To search for a specific work item, use the issues search command with the `--key` argument and the (case-sensitive) issue key.
$ jiratui issues search --key SCRUM-1
"""

[[commands.subcommand.field]]
id = "project_key"
label = "Project key"
type = "string"
option = ["--project-key"]
sources = ["readme"]

[[commands.subcommand.field]]
id = "key"
label = "Issue key"
type = "string"
option = ["--key"]
sources = ["readme"]

[[commands.subcommand.task]]
id = "by_project"
label = "Search a project"
fields = ["project_key"]
required = ["project_key"]

[[commands.subcommand.task]]
id = "by_key"
label = "Find one issue"
fields = ["key"]
required = ["key"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["project_key", "key"]