EDJX CLI

The EDJX Command Line Interface (CLI) 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

    sudo wget https://resources.edjx.io/prod/edjcli/latest/linux/amd64/edjx -O /usr/bin/edjx && sudo chmod +x /usr/bin/edjx

    MacOS

    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

    Windows PowerShell

    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.

    root@edjx:~ # 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:~ #

Additional Information

If you are planning to use the EDJX Platform to build your functions:

  1. Install Rust, the supported coding language.

  2. Install the Rust WASM target:

    rustup target add wasm32-unknown-unknown

Refer to the Library SDK for Rust and Rust Examples for advanced details.

CLI Commands

Note for WSL Users

If you are using Windows Subsystem for Linux (WSL), make sure you have the following installed on your Windows system:

  • Remote - WSL for VSCode extension.

  • Rust for WSL
    Execute the following commands in your WSL terminal:

    sudo apt-get update
    sudo apt install build-essential
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    The path for your WSL directory should look something like \\wsl$\Ubuntu\home\. This is where you will store the EDJX configuration for building and deploying functions.