CLI & API Reference

Author:Fraser Lennox
Updated:Mar 27, 2025

Table of Contents

Esadax CLI

Learn how to use the Esadax command-line interface (CLI) to manage and configure your Esadax Projects, Deployments and more from the command line.

Esadax REST API

Learn how to use the Esadax REST API to interact programmatically with your Esadax Projects and Deployments using HTTP requests.

Build Output API

Learn how you can use the Build Output API to enable your framework to integrate with Esadax's Build System.

Esadax CLI

Usage

esadax [command] [options]

Commands

  • init: Initialize a new Esadax project.
  • build: Build a Esadax project.
  • deploy: Deploy a Esadax project.
  • status: Display the status of a Esadax project.

Esadax REST API

Endpoints

  • GET /projects: Retrieve a list of projects.
  • POST /projects: Create a new project.
  • GET /projects/{id}: Retrieve a project by ID.
  • PUT /projects/{id}: Update a project.
  • DELETE /projects/{id}: Delete a project.

API Keys

To use the Esadax REST API, you need to obtain an API key. You can do this by creating a new account on the Esadax website and navigating to your account settings.

Build Output API

Usage

esadax build-output [options]

Options

  • --token: Specify the API token.
  • --project-id: Specify the project ID.
  • --build-id: Specify the build ID.