id       = "ykman"
name     = "YubiKey Manager"
homepage = "https://developers.yubico.com/yubikey-manager/"
description = "Python library and command line tool for configuring any YubiKey over all USB interfaces."
executables   = ["ykman"]

[dotfiles]

# Yubico's source documentation at
# https://developers.yubico.com/yubikey-manager/API_Documentation/_modules/ykman/settings.html
# defines XDG_CONFIG_HOME (default ~/.config) + /ykman and constructs
# <name>.json files there; AppData uses XDG_DATA_HOME (default ~/.local/share)
# + /ykman in the same way. The wildcard covers the named settings files
# without guessing which Settings/AppData name a future command adds.
paths = [
  "[configHome]/ykman/*.json",
  "[xdgData]/ykman/*.json",
]
secret = []

[commands]
format = 1
label = "YubiKey Manager"
description = "Inspect connected YubiKeys. Credential, PIV, OpenPGP, FIDO and OTP management are outside this form."
quality = "ai-draft"
base = "fig:ykman"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/ykman.ts"
license = "MIT"

[[commands.subcommand]]
path = ["info"]
label = "YubiKey info"

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/ykman.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "check_fips"
label = "Check FIPS mode"
type = "boolean"
option = ["--check-fips", "-c"]
sources = ["fig"]

[[commands.subcommand.task]]
id = "info"
label = "Show device info"
fields = ["check_fips"]
required = []

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

[[commands.subcommand]]
path = ["list"]
label = "List YubiKeys"

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/ykman.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "serials"
label = "Serial numbers only"
type = "boolean"
option = ["--serials", "-s"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "readers"
label = "List smart card readers"
type = "boolean"
option = ["--readers", "-r"]
sources = ["fig"]

[[commands.subcommand.task]]
id = "list"
label = "List devices"
fields = ["serials", "readers"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["serials", "readers"]