Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Akkeris Command Line Interface


npm -g install akkeris

More information can be found in the documentation

Environment Variables

export AKKERIS_HELP_OLD=true   # Always show the old Akkeris help

Other env

These environment variables are only useful if for development.

export API_AUTH = ".." # used to send "Authorization: ${API_AUTH}"
export API_TOKEN = ".." # used to send "Authorization: Bearer ${API_TOKEN}"
export AKA_UPDATE_INTERVAL # how often to check for updates (ms, default is 24 hours)

Make sure you've added the entries to .netrc as well.


Running in Docker

If you don't want to have Node.js installed, or just want to run the Akkeris CLI in a Docker container, you can build a Docker image with:

docker build -t akkeris-cli .

Or use pre-built image from DockerHub: akkeris/cli


You can optionally bind your ~/.netrc and ~/.akkeris/config.json files to the Docker container so you don't have to go through the profile setup and login process each time you use the container. If you don't have either of those files set up yet, create them.

For example, on MacOS:

touch ~/.netrc && mkdir -p ~/.akkeris && touch ~/.akkeris/config.json
docker run --rm -it -v ~/.netrc:/root/.netrc -v ~/.akkeris/config.json:/root/.akkeris/config.json akkeris/cli [COMMAND]


You can bind a plugins directory to the Docker container if you want to have plugins persist between usages of the Docker container:

docker run --rm -it -v ~/.akkeris/plugins/:/root/.akkeris/plugins/ akkeris/cli [COMMAND]


For easier use, you can add an alias to your bash profile:

alias aka="docker run --rm -it -v ~/.akkeris/plugins/:/root/.akkeris/plugins/ -v ~/.netrc:/root/.netrc -v ~/.akkeris/config.json:/root/.akkeris/config.json akkeris/cli"

Then, you can run Akkeris commands inside a Docker container like you had the Akkeris CLI installed locally: aka version


Getting Started

# Clone the repo via HTTPS
git clone
# Or via SSH
git clone

# Change directories into the repo
cd cli

# Install dependencies
npm install

# Create a `.env` file from the `.env.example` file
cp -v .env.example .env
# Modify any environment variable values in `.env` as necessary

# Run the local version of the Akkeris CLI by replacing `aka` with `npm run aka`
npm run aka

# Append any `aka` sub-commands onto the end, such as
npm run aka auth:login
npm run aka apps
npm run aka squirrel
# And you're off to the races!