Use Akamai CLI to configure Akamai platform and products directly from the command line. You can install ready-to-use product packages or build your own custom solutions to manage from CLI.
- Simple and task-oriented interface
- Consistent user experience across all Akamai products
- Wide range of supported packages and capabilities
- Extend or build your own CLI packages with supported programming languages such as Go, Python, and JavaScript
Browse the list of available packages.
Akamai CLI doesn't have any dependencies and is quick to install. However, you may need an additional runtime for packages depending on the programming language they are based on.
Install Akamai CLI by downloading a release binary. See instructions for various operating systems.
You can also use Homebrew, Docker, or compile from source.
If you're using a Python-based CLI package, install these extra dependencies:
- Python 3.3 or above
- Python 3
pippackage installer - Python 3
venvmodule - Up-to-date common CA certificates for your operating system (PEM files)
Follow the instructions for your operating system.
Once you download the appropriate binary for your system, make it executable, and optionally make it available in your $PATH. Run the following commands:
$ chmod +x ~/Downloads/akamai-<VERSION>-<PLATFORM>
$ mv ~/Downloads/akamai-<VERSION>-<PLATFORM> /usr/local/bin/akamaiOnce you download the appropriate binary for your system, simply execute the binary from the command line. For example:
$ akamai.exe helpYou can also install Akamai CLI using the Homebrew package manager. If you haven’t used it before, check Homebrew documentation for system requirements and read the installation guide.
Once set up, simply run:
$ brew install akamaiThis command compiles and globally installs the binary with all necessary dependencies.
A container with Akamai CLI and pre-installed public packages is also available in Docker. All images are built using Docker files from the akamai-docker repository. You can find all Akamai builds on Docker Hub.
To start, create and run the container with Akamai Development Environment:
$ docker run -it -v $HOME/.edgerc:/root/.edgerc:ro akamai/shellNote: This mounts your local
$HOME/.edgercinto the container. To change the local path, modify the-vargument.
The akamai command and basic packages are already installed. See the akamai-docker repository for more details.
If you want to open Akamai Development Environment when calling the akamai command, add the following line to your .bashrc, .bash_profile, or .zshrc files:
alias akamai='docker run -it -v $HOME/.edgerc:/root/.edgerc:ro akamai/shell'If you want to use a local .akamai-cli directory to configure and manage your installed packages, modify the -v argument:
$ docker run -it -v $HOME/.akamai-cli:/cli/.akamai-cli akamai/shellThis command installs the CLI and persists the configuration and packages in $HOME/.akamai-docker directory.
Prerequisite: Make sure you install Go 1.17 or later.
To compile Akamai CLI from source:
-
Change the working directory:
$ cd $GOPATH
-
Fetch the package:
$ git clone github.com/akamai/cli
-
Go to the package directory:
$ cd cli -
Compile the binary:
- For Linux, macOS, and other Unix-based systems, run:
go build -o akamai cli/main.go - For Windows, run:
go build -o akamai.exe cli/main.go
- Move the
akamaiorakamai.exebinary so that it's available in your$PATH.
Akamai-branded packages use a .edgerc file for standard EdgeGrid authentication. By default, CLI looks for credentials in your $HOME directory.
You can override both the file location or the credentials section by passing the --edgerc or --section flags to each command.
To set up your .edgerc file, see Get started with APIs.
Unless you installed Akamai CLI with Homebrew, you can enable automatic check for updates when you run Akamai CLI v0.3.0 or later for the first time.
When run for the first time, CLI asks you to enable automatic upgrades. If you do not agree, last-upgrade-check=ignore is set in the .akamai-cli/config file (this option will still allow you to perform manual upgrade as explained below). Otherwise, if a new version is available, CLI prompts you to download it. Akamai CLI automatically checks the new version's SHA256 signature to verify it is not corrupt. After the update, your original command executes using the new version.
For information on manual upgrade and the supported Homebrew command, see akamai upgrade in Built-in commands.
All CLI commands start with the akamai binary, followed by a command, and optionally an action or other arguments.
akamai [global flags] [command] [action] [arguments...]Use following flags to modify the Akamai CLI behaviour or get additional information:
-
--edgerc value, -e valueakamai --edgerc ~/.edgerc2 ...enables to use different configuration file than default~/.edgerc(in this case~/.edgerc2) -
--section value, -s valueakamai --section cps ...enables to use different section in configuration file than defaultdefault(in this casecps) -
--accountkey value, --account-key valueakamai --accountkey 1-ABCD:Z-XYZ ...enables to use account switch key (in this case1-ABCD:Z-XYZ) -
--helpakamai --helpshows basic usage info and available commands -
--bashakamai --bashshows help on using auto-complete with bash -
--zshakamai --zshshows help on using auto-complete with zsh -
--proxy valueakamai --proxy http://example.com:8080 ...sets a proxy to use (in this casehttp://example.com:8080) -
--versionakamai --versionshows version number of currently installed Akamai CLI
Use the following commands to manage packages and the toolkit:
-
helpakamai helpshows basic usage info and available commands. To learn more about a specific command, runakamai help <command> [sub-command]. -
listakamai listshows a list of available commands. If a command doesn't display, ensure the binary is executable and in your$PATH. -
installThis installs new packages from a git repository.
akamai install <package name or repository URL>downloads and installs the command repository to the$HOME/.akamai-clidirectory.For Github repositories, specify
user/repoororganization/repo. For official Akamai packages, you can omit theakamai/cli-prefix. For example, to installakamai/cli-property-manager, it's enough to runproperty-manager.These examples all install Akamai CLI for Property Manager from Github using various aliases:
akamai install property-manager akamai install akamai/cli-property-manager akamai install https://github.com/akamai/cli-property-manager.git
The
installcommand accepts more than one argument, so you can install many packages at once using any of these types of syntax. -
uninstallTo remove all the package files you installed with
akamai install, runakamai uninstall <command>, where<command>is any command within that package.The
uninstallcommand accepts more than one argument, so you can uninstall many packages at once. -
updateTo update a package you installed with
akamai install, runakamai update <command>, where<command>is any command within that package.You can specify multiple packages to update at once.
If you don't specify additional arguments,
akamai updateupdates all packages installed withakamai install -
upgradeManually upgrade Akamai CLI to the latest version.
If you installed Akamai CLI with Homebrew, run this command instead:
$ brew upgrade akamai
-
searchSearch all the packages published on developer.akamai.com for the submitter string. Searches apply to the package name, alias, and description. Search results appear in the console output.
-
configView or modify the configuration settings that drive the common CLI behavior. Akamai CLI maintains a local configuration file in its root directory. The
configcommand supports these sub-commands:getsetlistunsetorrm
This commands depend on your installed packages. To use an installed command, run akamai <command> <action> [arguments], for example:
akamai property-manager new-property -p example.org -g grp_123456 -c ctr_X-XXXXXX -d prd_Web_App_AccelFor the list of supported commands, see the documentation for each package.
Akamai CLI provides a framework for writing custom CLI commands. See the extended Akamai CLI documentation to learn how to contribute, create custom packages, and build commands.
Before you start to build your own commands, make sure you meet these prerequisites:
- The package is available through a Git repository that supports standard SSH public key authentication.
- The executable is named
akamai-<command>using dashed-lowercase, orakamai<Command>using camelCase. - Verify that
akamai-command helpworks for you. Ideally, CLI should allow forakamai-command help <sub-command>. - If you're using Akamai APIs, the executable must support the
.edgercformat, and must support both--edgercand--sectionflags. - If an action fails to complete, the executable exits with a non-zero status code.
As long as the result is executable, you can use any of the supported languages to build your commands, including Python, Go, and JavaScript.
To see additional log information, prepend AKAMAI_LOG=<logging-level> to any CLI command. You can specify one of the following logging levels:
fatalerrorwarninfodebug
For example, to see extra debug information while updating the property-manager package, run:
AKAMAI_LOG=debug akamai update property-managerEach level is a progressive superset of all previous tiers. The output for debug also includes fatal, error, warn, and info logs.
If you want to redirect logs to a file, use the AKAMAI_CLI_LOG_PATH environmental variable:
AKAMAI_LOG=debug AKAMAI_CLI_LOG_PATH=akamai.log akamai update property-managerAkamai CLI supports the following package managers that help you automatically install package dependencies:
- Python:
pip(usingrequirements.txt) - Go:
go modules - JavaScript:
npmandyarn
If you want to use other languages or package managers, make sure you include all dependencies in the package repository.
The package you install needs a cli.json file. This is where you specify the command language runtime version and define all commands included in package.
-
requirements: Specifies the runtime requirements. You may specify a minimum version number or use the*wildcard for any version. Possible requirements are:gonodepython
-
commands: Lists commands included in the package.-
name: The command name, used as the executable name. -
aliases: An array of aliases that invoke the same command. -
version: The command version. -
description: A short description for the command. -
bin: A URL to fetch a binary package from if it cannot be installed from source.The
binURL may contain the following placeholders:{{.Version}}: The command version.{{.Name}}: The command name.{{.OS}}: The current operating system, eitherwindows,mac, orlinux.{{.Arch}}: The current OS architecture, either386oramd64.{{.BinSuffix}}: The binary suffix for the current OS:.exeforwindows.
-
{
"requirements": {
"go": "1.8.0"
},
"commands": [
{
"name": "purge",
"version": "0.1.0",
"description": "Purge content from the Edge",
"bin": "https://github.com/akamai/cli-purge/releases/download/{{.Version}}/akamai-{{.Name}}-{{.OS}}{{.Arch}}{{.BinSuffix}}"
}
]
}When you complete an operation, Akamai CLI generates one of these exit codes:
0(Success) - Indicates that the latest command or script executed successfully.1(Configuration error) - Indicates an error while loadingAKAMAI_CLI_VERSIONorAKAMAI_CLI.2(Configuration error) - Indicates an error while creating thecache directory.3(Configuration error) - Indicates an error while saving thecache-path.5(Application error) - Indicates an error with the initial setup. Occurs when you run Akamai CLI for the first time.6(Syntax error) - Indicates that the latest command or script cannot be processed.7(Syntax error) - Indicates that the commands in your installed packages have conflicting names. To fix this, add a prefix to the commands that have the same name.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent