id = "ipinfo-cli"
name = "IPinfo CLI"
homepage = "https://github.com/ipinfo/cli"
description = "Official Command Line Interface for the IPinfo API (IP geolocation and other types of IP data)"
executables = ["ipinfo"]

[dotfiles]

# The upstream README's Docker example mounts /root/.config/ipinfo to save
# the CLI's config, and the project's support forum identifies
# ~/Library/Application Support/ipinfo/config.json on macOS. The same config
# file contains the token saved by `ipinfo init`, so it is a whole-file secret.
# https://github.com/ipinfo/cli#docker
# https://github.com/ipinfo/cli#login
# https://community.ipinfo.io/t/api-token-vs-access-token/6620/8
paths = []
secret = ["[appData]/ipinfo/config.json"]

[commands]
format = 1
label = "Look up an IP"
description = "Look up details for an IP address with the IPinfo CLI. Other subcommands (bulk, summarize, myip and so on) are not covered."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = false, short_bundles = false }

[[commands.source]]
id = "readme"
kind = "manual"
url = "https://github.com/ipinfo/cli/blob/master/README.md"
revision = "README"
evidence = """
ipinfo 8.8.8.8
All our CLIs respect either the `--nocolor` flag or the `NO_COLOR` environment variable to disable color output.
"""

[[commands.field]]
id = "ip"
label = "IP address"
type = "string"
position = 0
sources = ["readme"]

[[commands.field]]
id = "nocolor"
label = "Disable color"
type = "boolean"
option = ["--nocolor"]
sources = ["readme"]

[[commands.task]]
id = "lookup"
label = "Look up an IP"
fields = ["ip", "nocolor"]
required = ["ip"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["ip", "nocolor"]