Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 82 additions & 3 deletions docs/eigencompute/reference/ecloud-cli/compute/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Manage applications including creating, operating, and terminating.
* [list](#list)
* [info](#info)
* [logs](#logs)
* [releases](#releases)
* [profile](#profile)
* [configure](#configure)
* help, h
Expand Down Expand Up @@ -85,7 +86,8 @@ If you don't have an EigenCompute subscription, the CLI will prompt you for [bil

`ecloud compute app deploy [--name <value>] [--dockerfile <value>] [--image-ref <value>]
[--log-visibility] [--instance-type <value>] [--skip-profile] [--resource-usage-monitoring] [--website <value>]
[--description <value>] [--x-url <value>] [--image <value>] [--skip-profile] [global options]`
[--description <value>] [--x-url <value>] [--image <value>] [--skip-profile]
[--verifiable] [--repo <value>] [--commit <value>] [--build-dockerfile <value>] [--build-context <value>] [--build-dependencies <value>...] [global options]`

### Options

Expand Down Expand Up @@ -145,13 +147,41 @@ If you don't have an EigenCompute subscription, the CLI will prompt you for [bil

> Skip app profile setup.

`--verifiable`

> Enable verifiable build mode. Build from either:
> * Git source using `--repo` and `--commit`
> * Prebuilt verifiable image using `--image-ref`.

`--repo <value>`

> Git repository URL. Required with `--verifiable` when building from Git source.

`--commit <value>`

> Git commit SHA (40 hex chars). Required with `--verifiable` when building from Git source.

`--build-dockerfile <value>`

> Dockerfile path for verifiable build when building from Git source.

`--build-context <value>`

> Build context path for verifiable build when building from Git source.

`--build-dependencies=<value>...`

> Dependency digests for verifiable build when building from Git source (sha256:...).

## upgrade

Update an existing application with new code, configuration, or environment variables.

### Synopsis

`ecloud compute app upgrade [<app-id|name>] [--dockerfile value, -f value] [--log-visibility value] [--resource-usage-monitoring value] [--instance-type value] [--image_ref <value>] [global options]`
`ecloud compute app upgrade [<app-id|name>] [--dockerfile value, -f value] [--log-visibility value] [--resource-usage-monitoring value]
[--instance-type value] [--image_ref <value>] [--verifiable] [--repo <value>] [--commit <value>] [--build-dockerfile <value>]
[--build-context <value>] [--build-dependencies <value>...] [global options]`

### Arguments

Expand Down Expand Up @@ -182,6 +212,32 @@ Update an existing application with new code, configuration, or environment vari

> Machine instance type to use. One of `g1-standard-4t` or `g1-standard-8t`. Prompted for if not provided. Can be set using `ECLOUD_INSTANCE_TYPE`.

`--verifiable`

> Enable verifiable build mode. Build from either:
> * Git source using `--repo` and `--commit`
> * Prebuilt verifiable image using `--image-ref`.

`--repo <value>`

> Git repository URL. Required with `--verifiable` when building from Git source.

`--commit <value>`

> Git commit SHA (40 hex chars). Required with `--verifiable` when building from Git source.

`--build-dockerfile <value>`

> Dockerfile path for verifiable build when building from Git source.

`--build-context <value>`

> Build context path for verifiable build when building from Git source.

`--build-dependencies=<value>...`

> Dependency digests for verifiable build when building from Git source (sha256:...).

## start

Start a previously stopped application.
Expand Down Expand Up @@ -301,6 +357,29 @@ View application logs from your TEE instance.

> Continuously fetch and display logs for application. Default is disabled.

## releases

Display app releases including verifiable builds and dependency builds.

### Synopsis

`ecloud compute app releases [app-id|name] [--json] [--full] [global options]`

### Arguments

`app-id|name` (string)

> Application ID or display name. Prompted for if not provided.

### Options

`--json`

> Output JSON instead of formatted text.

`--full`
> Display the full (multi-line) release details instead of a table.

## profile set

Update or specify application profile. The application profile properties are displayed on the Verifiability Dashboard for
Expand Down Expand Up @@ -354,4 +433,4 @@ For more information on configuring TLS, refer to [Configure TLS](../../../howto

### Synopsis

`ecloud compute app configure tls`
`ecloud compute app configure tls`
179 changes: 179 additions & 0 deletions docs/eigencompute/reference/ecloud-cli/compute/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
---
title: build
sidebar_position: 5
---

Submit a new verifiable build. For more information, refer to Submit verifiable builds in the How to section.

## Available Commands

* [submit](#submit)
* [list](#list)
* [logs](#logs)
* [status](#status)
* [info](#info)
* [verify](#verify)

## Global Options

Options available for all `build` subcommands are:

`--environment <env>` (string)

> Deployment environment to use. One of `mainnet-alpha` and `sepolia`. Can be set using environment variable `ECLOUD_ENV`.

`--rpc-url value ` (URL)

> RPC URL to connect to blockchain. Can be set using environment variable `ECLOUD_RPC_URL`.

`--private-key value` (string)

> Private key for signing transactions. Can be set using environment variable `ECLOUD_PRIVATE_KEY`.

`--verbose`

> Enable verbose logging.

## submit

Submit verifiable builds from Git source with provenance verification.

### Synopsis

`ecloud compute build submit [--repo <value>] [--commit <value>] [--dockerfile <value>] [--build-caddyfile <value>] [--context <value>] [--dependencies <value>...] [--no-follow] [--json] [global options]`

### Options

`--repo <value>`

> Git repository URL.

`--commit <value>`

> Git commit SHA (40 hex chars).

`--dockerfile <value>`

> Dockerfile path.

`--build-caddyfile <value>`

> Caddyfile path for builds. Optional.

`[--dependencies <value>...]`

> Dependency image digests to include. For more information, refer to Submit verifiable builds in the How to section.

`--no-follow`

> Exit after submission without streaming logs.

`--json`

> Output JSON instead of formatted text.

## list

List recent builds for your billing address.

### Synopsis

`ecloud compute build list [--limit <value>] [--offset <value>] [--json] [global options]`

### Options

`--limit <value>`

> Maximum number of builds to return (min 1, max 100). Default is `20`.

`--offset <value>`

> Number of builds to skip.

`--json`

> Output JSON instead of formatted text.

## logs

View or stream build logs in real-time using the `--follow` option.

### Synopsis

`ecloud compute build logs [BUILDID] [-follow] [--tail <value>] [global options]`

### Arguments

`BUILDID`

> Build ID.

### Options

`--follow`

> Follow logs in real-time.

`--tail <value>`

> Show last N lines.

## status

Status check for a specified build.

### Synopsis

`ecloud compute build status [BUILDID] [--json] [global options]`

### Arguments

`BUILDID`

> Build ID.

### Options

`--json`

> Output JSON instead of formatted text.

## info

Full build details including dependency tree.

### Synopsis

`ecloud compute build info [BUILDID] [--json] [global options]`

### Arguments

`BUILDID`

> Build ID.

### Options

`--json`

> Output JSON instead of formatted text.

## verify

Verify provenance for a build ID, image digest, or commit SHA.

### Synopsis

`ecloud compute build verify [IDENTIFIER] [--json] [global options]`

### Arguments

`IDENTIFIER`

> Build ID, image digest (sha256:...), or git commit SHA.

### Options

`--json`

> Output JSON instead of formatted text.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: environment
sidebar_position: 5
sidebar_position: 6
---

Manage deployment environments to switch between Mainnet and Sepolia testnet.
Expand Down