Skip to main content

Install the EDK CLI

To use Elara, you first need to install the Elara Development Kit Command-Line Interface (EDK CLI).

In this tutorial, you will install the EDK CLI on your machine.

Install the Prerequisites

The EDK CLI can be installed on both Linux and Windows via the command-line. The EDK CLI is distributed as a node package available on NPM, so both Node.js and NPM are prerequisites for the installation of the EDK CLI. The EDK CLI requires a minimum version Node.js 20 and NPM 10.

The recommended approach to install Node.js and NPM on Linux or Windows is via NVM. The following instructions will allow you to install NVM along with the recommended Node.js and NPM version on Linux or Windows via the command-line.

Install NVM for Linux via it's

installation instructions. After successfully installing NVM, restart bash.

exec bash

Then install the 20 version of Node.js. This command also installs the minimum lts version of NPM.

nvm install 20

Which will result in:

Now using node 20 (npm lts)

Next, set 20 as the default Node.js version. This ensures Node.js 20 and NPM lts are used in new shells.

nvm alias default 20

Which will result in:

default -> 20 (-> 20)

Install the EDK CLI

Install the latest version of the EDK CLI globally.

npm install -g @elaraai/cli

Validate your EDK CLI Installation

Validate that the installation has completed by running edk --help. If the installation has completed successfully, the terminal output available commands for the EDK CLI.

Usage: edk [options] [command]

Options:
  -V, --version        output the version number
  -h, --help           display help for command

Commands:
  project <command>    manage projects
  asset <command>      manage assets
  template <command>   manage templates
  tenant <command>     manage tenants
  workspace <command>  manage workspaces
  task <command>       manage tasks
  stream <command>     manage streams
  layout <command>     manage layouts
  auth <command>       manage authentication
  user <command>       manage users
  role <command>       manage user roles
  help [command]       display help for command

Next steps

Now that you have the EDK CLI installed, continue to the next tutorial to log in to Elara platform from your machine and access the management portal.

On this page