| name | agentuity-cli-cloud-sandbox-snapshot-build |
| description | Build a snapshot from a declarative file. Requires authentication. Use for Agentuity cloud platform operations |
| version | 0.1.11 |
| license | Apache-2.0 |
| allowed-tools | Bash(agentuity:*) |
| argument-hint | <directory> |
| metadata | {"command":"agentuity cloud sandbox snapshot build","tags":"slow requires-auth"} |
Cloud Sandbox Snapshot Build
Build a snapshot from a declarative file
Prerequisites
- Authenticated with
agentuity auth login
- Organization context required (
--org-id or default org)
Usage
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) |
--metadata | array | Yes | - | Metadata key-value pairs (KEY=VALUE) |
--force | boolean | Yes | - | Force rebuild even if content is unchanged |
Examples
Build a snapshot from the current directory using agentuity-snapshot.yaml:
bunx @agentuity/cli cloud sandbox snapshot build .
Build using a custom build file:
bunx @agentuity/cli cloud sandbox snapshot build ./project --file custom-build.yaml
Build with environment variable substitution and custom tag:
bunx @agentuity/cli cloud sandbox snapshot build . --env API_KEY=secret --tag production
Validate the build file without uploading:
bunx @agentuity/cli cloud sandbox snapshot build . --dry-run
Force rebuild even if content is unchanged:
bunx @agentuity/cli cloud sandbox snapshot build . --force
Output
Returns JSON object:
{
"snapshotId": "string",
"name": "string",
"tag": "unknown",
"runtime": "string",
"sizeBytes": "number",
"fileCount": "number",
"createdAt": "string",
"unchanged": "boolean",
"userMetadata": "object"
}
| 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 |