EDJX CLI

The EDJX Command Line Interface (edjCLI) is a unified tool used to manage your EDJX instance and interact with other EDJX features and services.

1. Install the CLI

  1. Sign up for an EDJX account.
    Create your login credentials here.

  2. Install the CLI.

    • Linux

    • MacOS

    • Windows PowerShell

    sudo wget https://resources.edjx.io/prod/edjcli/latest/linux/amd64/edjx -O /usr/bin/edjx && sudo chmod +x /usr/bin/edjx
    sudo curl -L "https://resources.edjx.io/prod/edjcli/latest/darwin/amd64/edjx" -o /usr/local/bin/edjx && sudo chmod +x /usr/local/bin/edjx
    Invoke-WebRequest -Uri https://resources.edjx.io/prod/edjcli/latest/windows/amd64/edjx.exe -OutFile edjx.exe

2. Initialize the CLI on the System

  1. Open a terminal session on the machine as root user.

    root@edjx:~ #
  2. Initialize the EDJX CLI.
    You only need to do this the first time you log in.

    edjx config init
    If you want to use an environment other than edjx.net, refer to the edjx config init page.
  3. Log into the EDJX Platform.

    root@edjx:~ # edjx login
    Username: <email>
    Password: **********
    Logged in successfully
    root@edjx:~ #

Note for WSL Users

If you are using Windows Subsystem for Linux (WSL), make sure you install the latest version of Remote - WSL for VSCode.

The path for your WSL directory should look something like \\wsl$\Ubuntu\home\.

This is the default directory where the EDJX configuration files (edjconfig.yaml) are stored for building and deploying functions.