Home ci 37. cli-api: cli api

37. cli-api: cli api

Last updated on Aug 05, 2025

CLI & API Reference

Table of Contents

Epycbyte CLI

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

Epycbyte REST API

Learn how to use the Epycbyte REST API to interact programmatically with your Epycbyte 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 Epycbyte's Build System.

Epycbyte CLI

Usage

epycbyte [command] [options]

Commands

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

Epycbyte 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 Epycbyte REST API, you need to obtain an API key. You can do this by creating a new account on the Epycbyte website and navigating to your account settings.

Build Output API

Usage

epycbyte build-output [options]

Options

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