id       = "vultr-cli"
name     = "vultr-cli"
homepage = "https://github.com/vultr/vultr-cli"
description = "Official command line tool for Vultr services"
icon     = "SimpleIcons:vultr"
executables   = ["vultr-cli"]

[dotfiles]

# There is no ordinary config to sync. The README is explicit about what the
# config file may hold: "Currently the only available field that you can use
# with a config file is api-key. Your yaml file will have a single entry which
# would be: api-key: MYKEY". Everything else is flags and VULTR_API_KEY.
paths = []

exclude = []

# cmd/root.go, configHome(): the CLI looks for `os.UserConfigDir()/vultr-cli.yaml`
# first and falls back to `os.UserHomeDir()/.vultr-cli.yaml`. Go's
# os.UserConfigDir is $XDG_CONFIG_HOME (or ~/.config) on Linux,
# ~/Library/Application Support on macOS and %AppData% on Windows — that is
# `[appData]`, so the searched directory is one entry and the home-directory
# fallback the other. The whole file is the API key.
secret = [
  "[appData]/vultr-cli.yaml",
  "~/.vultr-cli.yaml",
]

[commands]
format = 1
label = "Vultr instances"
description = "Create, inspect and delete Vultr instances. Requires VULTR_API_KEY; other resource types are left out."
quality = "ai-draft"
base = "fig:vultr-cli"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = true }

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

[[commands.subcommand]]
path = ["instance", "create"]
label = "Create an instance"
description = "Create a server from an OS, plan and region ID."

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

[[commands.subcommand.field]]
id = "os"
label = "Operating system ID"
type = "string"
option = ["--os", "-o"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "plan"
label = "Plan ID"
type = "string"
option = ["--plan", "-p"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "region"
label = "Region ID"
type = "string"
option = ["--region", "-r"]
sources = ["fig"]

[[commands.subcommand.task]]
id = "create"
label = "Create instance"
fields = ["os", "plan", "region"]
required = ["os", "plan", "region"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["os", "plan", "region"]

[[commands.subcommand]]
path = ["instance", "get"]
label = "Show an instance"
description = "Get information about one instance."

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

[[commands.subcommand.field]]
id = "instance_id"
label = "Instance ID"
type = "string"
position = 0
sources = ["fig"]

[[commands.subcommand.task]]
id = "get"
label = "Show instance"
fields = ["instance_id"]
required = ["instance_id"]

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

[[commands.subcommand]]
path = ["instance", "delete"]
label = "Delete an instance"
description = "Permanently destroy an instance."

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

[[commands.subcommand.field]]
id = "instance_id"
label = "Instance ID"
description = "Destroys the instance."
type = "string"
position = 0
effect = "delete"
sources = ["fig"]

[[commands.subcommand.task]]
id = "delete"
label = "Delete instance"
fields = ["instance_id"]
required = ["instance_id"]

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