Cloud Sandbox Snapshot Build

Name: agentuity-cli-cloud-sandbox-snapshot-build
Rating: 62
Author: agentuity

Build a snapshot from a declarative file

Prerequisites

•Authenticated with agentuity auth login
•Organization context required (--org-id or default org)

Usage

bash

agentuity cloud sandbox snapshot build <directory> [options]

Arguments

Argument	Type	Required	Description
`<directory>`	string	Yes	-

Options

Option	Type	Required	Default	Description
`--file`	string	Yes	-	Path to build file (defaults to agentuity-snapshot.[json
`--env`	array	Yes	-	Environment variable substitution (KEY=VALUE)
`--name`	string	Yes	-	Snapshot name (overrides build file)
`--tag`	string	Yes	-	Snapshot tag (defaults to "latest")
`--description`	string	Yes	-	Snapshot description (overrides build file)
`--message`	string	Yes	-	Build message for this snapshot
`--commit`	string	Yes	-	Git commit SHA (auto-detected if not provided)
`--branch`	string	Yes	-	Git branch (auto-detected if not provided)
`--repo`	string	Yes	-	Git repo URL (auto-detected if not provided)
`--provider`	string	Yes	-	Git provider (github, gitlab, bitbucket - auto-detected)
`--commitUrl`	string	Yes	-	URL to the commit
`--metadata`	array	Yes	-	Metadata key-value pairs (KEY=VALUE)
`--force`	boolean	Yes	-	Force rebuild even if content is unchanged
`--public`	boolean	Yes	-	Make snapshot public (enables virus scanning, no encryption)
`--confirm`	boolean	Yes	-	Confirm public snapshot publishing (required for --public)

Examples

Build a snapshot from the current directory using agentuity-snapshot.yaml:

bash

bunx @agentuity/cli cloud sandbox snapshot build .

Build using a custom build file:

bash

bunx @agentuity/cli cloud sandbox snapshot build ./project --file custom-build.yaml

Build with environment variable substitution and custom tag:

bash

bunx @agentuity/cli cloud sandbox snapshot build . --env API_KEY=secret --tag production

Validate the build file without uploading:

bash

bunx @agentuity/cli cloud sandbox snapshot build . --dry-run

Force rebuild even if content is unchanged:

bash

bunx @agentuity/cli cloud sandbox snapshot build . --force

Output

Returns JSON object:

json

{
  "snapshotId": "string",
  "name": "string",
  "tag": "unknown",
  "runtime": "string",
  "sizeBytes": "number",
  "fileCount": "number",
  "createdAt": "string",
  "unchanged": "boolean",
  "userMetadata": "object",
  "error": "string",
  "malwareDetected": "boolean",
  "virusName": "string"
}

Field	Type	Description
`snapshotId`	string	Snapshot ID
`name`	string	Snapshot name
`tag`	unknown	Snapshot tag
`runtime`	string	Runtime identifier
`sizeBytes`	number	Snapshot size in bytes
`fileCount`	number	Number of files in snapshot
`createdAt`	string	Snapshot creation timestamp
`unchanged`	boolean	True if snapshot was unchanged
`userMetadata`	object	User-defined metadata key-value pairs
`error`	string	Error message if build failed
`malwareDetected`	boolean	True if malware was detected
`virusName`	string	Name of detected virus