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 EdjCLI

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

  2. Install the CLI.

    • Linux

    • MacOS - Intel

    • Windows PowerShell

    mkdir -p ~/edjx/bin
    wget "https://resources.edjx.io/prod/edjcli/latest/linux/amd64/edjx" -O ~/edjx/bin/edjx && chmod +x ~/edjx/bin/edjx
    echo 'PATH="${HOME}/edjx/bin:${PATH}"' >> ~/.bash_profile
    source ~/.bash_profile
    mkdir -p ~/edjx/bin
    curl -L "https://resources.edjx.io/prod/edjcli/latest/darwin/amd64/edjx" -o ~/edjx/bin/edjx && chmod +x ~/edjx/bin/edjx
    echo 'PATH="${HOME}/edjx/bin:${PATH}"' >> ~/.zshrc
    source ~/.zshrc
    New-Item -ItemType "directory" -Path "$HOME\edjx\bin"
    Invoke-WebRequest -Uri "https://resources.edjx.io/prod/edjcli/latest/windows/amd64/edjx" -OutFile "$HOME\edjx\bin\edjx.exe"
    [Environment]::SetEnvironmentVariable("Path", "$HOME\edjx\bin;" + $([Environment]::GetEnvironmentVariable("Path", "User")), "User")

    Close the PowerShell window and open it again.

2. Initialize EdjCLI on the System

  1. Initialize EdjCLI.
    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.
  2. Log into the EdjPlatform.

    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.