id       = "doctl"
name     = "doctl"
homepage = "https://docs.digitalocean.com/reference/doctl/"
description = "doctl is a command-line interface (CLI) for the DigitalOcean API."
icon     = "SimpleIcons:digitalocean"
executables   = ["doctl"]

[dotfiles]

# README, "Configuring default values": "On OS X, doctl saves its configuration
# as ${HOME}/Library/Application Support/doctl/config.yaml"; "On Linux, doctl
# saves its configuration as ${XDG_CONFIG_HOME}/doctl/config.yaml … or
# ~/.config/doctl/config.yaml if it is not. On Windows, the config file
# location is %APPDATA%\doctl\config.yaml." One file under three names, which
# is [appData].
paths = ["[appData]/doctl/config.yaml"]

exclude = []

# The file is not a whole-file secret: it also stores the defaults for every
# command flag (`compute.ssh.ssh-user`, `output`, …), which are worth syncing.
secret = []

# Read once per invocation via viper; nothing holds it open.
side_effect = false

# `access-token` is the API token `doctl auth init` writes, and `auth-contexts`
# maps each named context to its own token (commands/auth.go reads
# viper.GetStringMap("auth-contexts")). The rule names the base directory, so
# it runs on all three platforms — a rule naming only the XDG spelling would
# let the token sync in the clear from a Mac or a Windows machine.
[[dotfiles.secret_paths]]
file  = "[appData]/doctl/config.yaml"
match = { key_path = ["access-token", "auth-contexts.*"] }

[commands]
format = 1
label = "DigitalOcean CLI"
description = "Read-only listings for apps, databases, projects and the account. The access-token option is left out; authenticate with doctl auth init."
quality = "ai-draft"
base = "fig:doctl"
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/doctl.ts"
license = "MIT"

[[commands.subcommand]]
path = ["apps", "list"]
label = "List apps"
description = "Lists App Platform apps."

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

[[commands.subcommand.field]]
id = "output"
label = "Output format"
type = "string"
option = ["--output", "-o"]
suggestions = [{ value = "text", label = "text" }, { value = "json", label = "json" }]
sources = ["fig"]

[[commands.subcommand.task]]
id = "default"
label = "List apps"
fields = ["output"]
required = []

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

[[commands.subcommand]]
path = ["databases", "list"]
label = "List database clusters"
description = "Lists managed database clusters."

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

[[commands.subcommand.field]]
id = "output"
label = "Output format"
type = "string"
option = ["--output", "-o"]
suggestions = [{ value = "text", label = "text" }, { value = "json", label = "json" }]
sources = ["fig"]

[[commands.subcommand.task]]
id = "default"
label = "List database clusters"
fields = ["output"]
required = []

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

[[commands.subcommand]]
path = ["projects", "list"]
label = "List projects"
description = "Lists projects."

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

[[commands.subcommand.field]]
id = "output"
label = "Output format"
type = "string"
option = ["--output", "-o"]
suggestions = [{ value = "text", label = "text" }, { value = "json", label = "json" }]
sources = ["fig"]

[[commands.subcommand.task]]
id = "default"
label = "List projects"
fields = ["output"]
required = []

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

[[commands.subcommand]]
path = ["account", "get"]
label = "Account details"
description = "Shows account profile details."

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

[[commands.subcommand.field]]
id = "output"
label = "Output format"
type = "string"
option = ["--output", "-o"]
suggestions = [{ value = "text", label = "text" }, { value = "json", label = "json" }]
sources = ["fig"]

[[commands.subcommand.task]]
id = "default"
label = "Account details"
fields = ["output"]
required = []

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