Getting Started

Install Software Requirements

In order to install aek-cli, there are a few prerequisites. You will need a recent version of Git, NodeJS and npm. These are common development tools that you may already have. If so, skip to the next step. If not, please review the installation instructions here.

Install aek-cli

With npm installed, you can install aek-cli with a simple command:

npm install -g

Even if you have an existing version of aek-cli, we recommend executing this command to get the very latest version.

Test Your Installation

Simply run the following at the command line:


You should see the AEK command menu. If not have a look at the detailed installation instructions for common installation issues.

Create Your First Project

Create a suitable directory in your file system to house your AEK projects and navigate to that directory. eg

mkdir ~/my-aek-projects
cd ~/my-aek-projects

Now execute the “create” command to create your first project.

aek create

You will need to complete the prompts provided with details including the package name and the hostname for the app you want to proxy. Please select the “recommended” boilerplate. You may also need to login with your App Manager credentials. Once you have completed all the prompts, the most recent version of the boilerplate should begin to download and all the required dependencies will be installed locally to that project..

When this has completed, you can navigate to the project and start it up using the following commands:

cd my-new-project
aek start

This will startup a local server on port 5000. Open up your favorite browser and enter the address “http://localhost:5000”.

Read the Boilerplate Documentation

For an explanation of how the boilerplate is structured, have a look at the boilerplate documentation

Download and Review Our Examples

The boilerplate includes some basic example code but for a deeper look at some real life examples, checkout the aek-examples package.

Navigate back to your AEK projects folder (wherever you wish to install the new package) and run the following command:

aek pull aek-examples

This will download the package and install its dependencies.

You can then navigate to the new folder and start up the local server (make sure you have stopped any other servers):

cd aek-examples
aek start

Read the Library Documentation

To get started writing your own code, you will want to have a look at the library documentation. Most library code is contained in the aek-lib package and this has its own documentation.

Information on some other important packages can be found here.

Further Reading

The AEK framework and buildtools are developed using some common 3rd party libraries such as (React, Babel, Webpack, Gulp, etc). If you are not yet familiar with these tools, checkout our reading list for more information.