id       = "akamai-cli"
name     = "Akamai CLI"
homepage = "https://techdocs.akamai.com/developer/docs/about-clis"
description = "Manage and configure Akamai from the Command Line."
icon     = "SimpleIcons:akamai"
executables = ["akamai"]

[dotfiles]

# https://techdocs.akamai.com/developer/docs/about-clis — declining the
# automatic update check sets `last-upgrade-check=ignore` "in the
# `.akamai-cli/config` file", i.e. ~/.akamai-cli/config, an ini file. The rest
# of ~/.akamai-cli holds the installed command packages (git checkouts under
# src/) and their caches, which are installs rather than settings; naming the
# one file rather than the directory leaves them out without needing an
# exclude.
paths = ["~/.akamai-cli/config"]

exclude = []

# https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials —
# the credentials live in `.edgerc` "in your local home or root directory", one
# bracketed section per API client holding `client_secret`, `host`,
# `access_token` and `client_token`. Every field in it is a credential, so the
# file is a whole-file secret rather than something to pick apart. It is not
# only the CLI's: every Akamai API client reads the same file.
secret = ["~/.edgerc"]

# `last-upgrade-check` records when *this* installation last asked Akamai
# whether a newer CLI exists (or `ignore` when the user declined). Carrying one
# machine's answer to another either suppresses its first update prompt or
# back-dates it. Source as above.
[[dotfiles.machine_lines]]
file  = "~/.akamai-cli/config"
match = { prefix = ["last-upgrade-check"] }

[commands]
format = 1
label = "Run Akamai CLI"
description = "Run an Akamai CLI command with the credentials file, section and account switch key chosen. The command and its arguments are entered as free text."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = false, short_bundles = false }

[[commands.source]]
id = "readme"
kind = "manual"
url = "https://github.com/akamai/cli/blob/master/README.md"
revision = "master 2026-10"
evidence = """
akamai [global flags] [command] [action] [arguments...]
| `--edgerc` (string) | Alias `-e`. The location of your credentials file. The default is `$HOME/.edgerc`. |
| `--section` (string) | Alias `-s`. A credential set's section name. The default is `default`. |
| `--accountkey` (string) | Alias `--account-key`. An account switch key. |
| `--proxy` (string) | Sets a proxy to use. |
akamai list
akamai install {package name or repository URL}
akamai update {command}
"""

[[commands.field]]
id = "edgerc"
label = "Credentials file"
type = "path"
option = ["--edgerc"]
path = { kind = "file", role = "input" }
sources = ["readme"]

[[commands.field]]
id = "section"
label = "Credentials section"
type = "string"
option = ["--section"]
sources = ["readme"]

[[commands.field]]
id = "accountkey"
label = "Account switch key"
type = "string"
option = ["--accountkey"]
sources = ["readme"]

[[commands.field]]
id = "proxy"
label = "Proxy"
type = "url"
option = ["--proxy"]
sources = ["readme"]

[[commands.field]]
id = "command"
label = "Command and arguments"
description = "For example list, install property-manager or update."
type = "string"
position = 0
multiple = true
sources = ["readme"]

[[commands.task]]
id = "list"
label = "List commands"
fields = ["command", "edgerc", "section"]
required = ["command"]
set = { command = ["list"] }

[[commands.task]]
id = "install"
label = "Install a package"
fields = ["command", "proxy"]
required = ["command"]
set = { command = ["install"] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["command", "edgerc", "section"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["accountkey", "proxy"]