Today is the first of our regular updates on the new Akamai CLI where we plan to keep you appraised of new features, changes, and new packages.
One of the primary goals for Akamai CLI is to maximize User Experience (UX) and Developer Experience (DX) when you work with the Akamai platform. Akamai CLI 0.3 brings some exciting new features that we hope will improve both on-boarding and maintenance experiences.
The first time you run Akamai CLI 0.3 and above, you’ll see the new on-boarding experience. The first part of this ensures that Akamai CLI is installed somewhere in your
PATH, if it is not, then we give you the option to install it, and ask where in your
PATH it should be moved.
Additionally, it will ask if you would like to do (at most) daily checks for upgrades to Akamai CLI. If you choose yes, it will check to see if there is an upgrade and prompt you to install if there is.
If you enable Automatic Upgrading, every time you invoke Akamai CLI, if it has been at least a day since it last checked, it will automatically check for upgrades and prompt you to install if there have been.
Upgrades are performed in-place, and whatever command you invoked will then be executed using the new version of Akamai CLI.
If you disable this feature, or want to manually upgrade at any time, you can run the new
akamai upgrade command.
Upgrade files are automatically verified using a SHA256 checksum before being applied to ensure integrity. We’re also looking into how we might add cryptographically secure signature verification in a future release.
Akamai CLI for Visitor Prioritization
We’ll have a full blog post on this addition next week.
Another feature we’ve added is support for the macOS package manager, Homebrew. You can now install Akamai CLI on macOS with Homebrew using:
$ brew install akamai
Note: To ensure that we play nicely within the Homebrew ecosystem, or any other third party system package managers, both the first run and automatic updating features are disabled.
Install, Not Get
One simple but significant change (that we made with 0.2), is renaming the
get command to
install. We felt this made us more consistent with most other package managers out there, making it easier to remember, and discover.
We’ve made many updates to our documentation since our initial release, including within the README and within Akamai CLI itself. In particular,
akamai list has been reformatted, to better show command descriptions:
It’s also now possible to have multiple installs of Akamai CLI packages using the new
AKAMAI_CLI_HOME environment variable. By setting this, you can control exactly where Akamai CLI creates it’s
.akamai-cli directory, in which packages and preferences are stored.
We have several other new packages in the works, as well as better support for packages written using Java.
In addition, for Windows users, we’re aware of an issue that some people are running into because the executables are currently not Code Signed. In particular, within Enterprise environments Virus Scanners, or system settings may disable the ability to run unsigned executables. We’re looking into a few potential solutions for this.
Lastly, we’re working on a brand new contributors and package creators guide so you can create your own custom packages according to your specific needs.