diff --git a/docs/eigencompute/reference/ecloud-cli/compute/app.md b/docs/eigencompute/reference/ecloud-cli/compute/app.md index 9077750d..c3ea854a 100644 --- a/docs/eigencompute/reference/ecloud-cli/compute/app.md +++ b/docs/eigencompute/reference/ecloud-cli/compute/app.md @@ -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 @@ -85,7 +86,8 @@ If you don't have an EigenCompute subscription, the CLI will prompt you for [bil `ecloud compute app deploy [--name ] [--dockerfile ] [--image-ref ] [--log-visibility] [--instance-type ] [--skip-profile] [--resource-usage-monitoring] [--website ] -[--description ] [--x-url ] [--image ] [--skip-profile] [global options]` +[--description ] [--x-url ] [--image ] [--skip-profile] +[--verifiable] [--repo ] [--commit ] [--build-dockerfile ] [--build-context ] [--build-dependencies ...] [global options]` ### Options @@ -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 ` + +> Git repository URL. Required with `--verifiable` when building from Git source. + +`--commit ` + +> Git commit SHA (40 hex chars). Required with `--verifiable` when building from Git source. + +`--build-dockerfile ` + +> Dockerfile path for verifiable build when building from Git source. + +`--build-context ` + +> Build context path for verifiable build when building from Git source. + +`--build-dependencies=...` + +> 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 [] [--dockerfile value, -f value] [--log-visibility value] [--resource-usage-monitoring value] [--instance-type value] [--image_ref ] [global options]` +`ecloud compute app upgrade [] [--dockerfile value, -f value] [--log-visibility value] [--resource-usage-monitoring value] +[--instance-type value] [--image_ref ] [--verifiable] [--repo ] [--commit ] [--build-dockerfile ] +[--build-context ] [--build-dependencies ...] [global options]` ### Arguments @@ -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 ` + +> Git repository URL. Required with `--verifiable` when building from Git source. + +`--commit ` + +> Git commit SHA (40 hex chars). Required with `--verifiable` when building from Git source. + +`--build-dockerfile ` + +> Dockerfile path for verifiable build when building from Git source. + +`--build-context ` + +> Build context path for verifiable build when building from Git source. + +`--build-dependencies=...` + +> Dependency digests for verifiable build when building from Git source (sha256:...). + ## start Start a previously stopped application. @@ -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 @@ -354,4 +433,4 @@ For more information on configuring TLS, refer to [Configure TLS](../../../howto ### Synopsis -`ecloud compute app configure tls` \ No newline at end of file +`ecloud compute app configure tls` diff --git a/docs/eigencompute/reference/ecloud-cli/compute/build.md b/docs/eigencompute/reference/ecloud-cli/compute/build.md new file mode 100644 index 00000000..94580b82 --- /dev/null +++ b/docs/eigencompute/reference/ecloud-cli/compute/build.md @@ -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 ` (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 ] [--commit ] [--dockerfile ] [--build-caddyfile ] [--context ] [--dependencies ...] [--no-follow] [--json] [global options]` + +### Options + +`--repo ` + +> Git repository URL. + +`--commit ` + +> Git commit SHA (40 hex chars). + +`--dockerfile ` + +> Dockerfile path. + +`--build-caddyfile ` + +> Caddyfile path for builds. Optional. + +`[--dependencies ...]` + +> 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 ] [--offset ] [--json] [global options]` + +### Options + +`--limit ` + +> Maximum number of builds to return (min 1, max 100). Default is `20`. + +`--offset ` + +> 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 ] [global options]` + +### Arguments + +`BUILDID` + +> Build ID. + +### Options + +`--follow` + +> Follow logs in real-time. + +`--tail ` + +> 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. \ No newline at end of file diff --git a/docs/eigencompute/reference/ecloud-cli/compute/environment.md b/docs/eigencompute/reference/ecloud-cli/compute/environment.md index 749976c3..f299fc43 100644 --- a/docs/eigencompute/reference/ecloud-cli/compute/environment.md +++ b/docs/eigencompute/reference/ecloud-cli/compute/environment.md @@ -1,6 +1,6 @@ --- title: environment -sidebar_position: 5 +sidebar_position: 6 --- Manage deployment environments to switch between Mainnet and Sepolia testnet.