From b1d088d50a8e2b304059204ff7a594ea1bb21f2a Mon Sep 17 00:00:00 2001 From: Parteek Singh Date: Mon, 12 Jan 2026 15:27:43 -0800 Subject: [PATCH] Updates - Fix inaccurate domain info in CLI commands - Add default resource configuration info - Add sandbox CLI commands - Remove legacy object storage CLI commands - Add CLI command for API key (authenticated) --- content/Reference/CLI/debugging.mdx | 3 + content/Reference/CLI/deployment.mdx | 32 ++-- content/Reference/CLI/getting-started.mdx | 8 + content/Reference/CLI/index.mdx | 2 +- content/Reference/CLI/sandbox.mdx | 183 +++++++++++++++++++++- content/Reference/CLI/storage.mdx | 57 ------- 6 files changed, 207 insertions(+), 78 deletions(-) diff --git a/content/Reference/CLI/debugging.mdx b/content/Reference/CLI/debugging.mdx index fc6fc3e8..1468e953 100644 --- a/content/Reference/CLI/debugging.mdx +++ b/content/Reference/CLI/debugging.mdx @@ -19,6 +19,9 @@ agentuity cloud ssh proj_abc123xyz # SSH into specific deployment agentuity cloud ssh dep_abc123xyz +# SSH into a sandbox +agentuity cloud ssh sbx_abc123xyz + # Run a command and exit agentuity cloud ssh 'ps aux' diff --git a/content/Reference/CLI/deployment.mdx b/content/Reference/CLI/deployment.mdx index 3f10b640..c190089c 100644 --- a/content/Reference/CLI/deployment.mdx +++ b/content/Reference/CLI/deployment.mdx @@ -244,10 +244,6 @@ Removing a deployment permanently deletes it. You cannot rollback to a removed d ## Custom Domains -You can configure custom domains using either the configuration file or CLI commands. - -### Option 1: Configuration File - Configure custom domains in `agentuity.json`: ```json @@ -313,25 +309,23 @@ After deployment with custom domains, the CLI only shows custom URLs: The project URL and deployment-specific URLs still exist but custom domains take precedence in the output. -### Option 2: CLI Commands - -Manage custom domains directly from the CLI: - -```bash -# List configured domains -agentuity cloud domain list - -# Add a domain -agentuity cloud domain add api.example.com +## Resource Configuration -# Remove a domain -agentuity cloud domain remove api.example.com +Configure CPU, memory, and disk limits in `agentuity.json`: -# Verify DNS configuration -agentuity cloud domain verify api.example.com +```json +{ + "deployment": { + "resources": { + "cpu": "500m", + "memory": "512Mi", + "disk": "1Gi" + } + } +} ``` -Use the configuration file for domains that should persist across deployments. Use CLI commands for quick testing or temporary domains. +**Defaults:** `cpu: "500m"`, `memory: "500Mi"`, `disk: "500Mi"` ## Environment Variables diff --git a/content/Reference/CLI/getting-started.mdx b/content/Reference/CLI/getting-started.mdx index 8d953453..ed49eb60 100644 --- a/content/Reference/CLI/getting-started.mdx +++ b/content/Reference/CLI/getting-started.mdx @@ -64,6 +64,14 @@ Check your authentication status: agentuity auth whoami ``` +### Get Your API Key + +Display the API key for your authenticated account: + +```bash +agentuity auth apikey +``` + ### Create a New Account Sign up for a new Agentuity account directly from the CLI: diff --git a/content/Reference/CLI/index.mdx b/content/Reference/CLI/index.mdx index b75071fb..b04f4a1c 100644 --- a/content/Reference/CLI/index.mdx +++ b/content/Reference/CLI/index.mdx @@ -20,7 +20,7 @@ See [Getting Started](/Reference/CLI/getting-started) for installation options, | [Getting Started](/Reference/CLI/getting-started) | `login`, `logout`, `new` | Install, authenticate, create projects | | [Development](/Reference/CLI/development) | `dev` | Local development server | | [Deployment](/Reference/CLI/deployment) | `deploy`, `cloud project` | Deploy and manage cloud projects | -| [Storage](/Reference/CLI/storage) | `cloud kv`, `cloud vector`, `cloud object`, `cloud redis` | Manage KV, vector, object, and Redis storage | +| [Storage](/Reference/CLI/storage) | `cloud kv`, `cloud vector`, `cloud s3`, `cloud redis` | Manage KV, vector, object, and Redis storage | | [Configuration](/Reference/CLI/configuration) | `cloud env`, `cloud secret`, `cloud apikey` | Manage env vars, secrets, and API keys | | [Debugging](/Reference/CLI/debugging) | `cloud ssh`, `cloud session` | SSH access, session inspection | | [AI Commands](/Reference/CLI/ai-commands) | `ai` | AI coding agent utilities | diff --git a/content/Reference/CLI/sandbox.mdx b/content/Reference/CLI/sandbox.mdx index 5db6fac1..2bad0350 100644 --- a/content/Reference/CLI/sandbox.mdx +++ b/content/Reference/CLI/sandbox.mdx @@ -20,8 +20,16 @@ All sandbox commands require the `cloud` prefix. For example: `agentuity cloud s | `sandbox delete ` | Destroy sandbox | | `sandbox exec -- ` | Execute in existing sandbox | | `sandbox cp` | Copy files to/from sandbox | +| `sandbox files ` | List files in sandbox | +| `sandbox mkdir ` | Create directory | +| `sandbox rmdir ` | Remove directory | +| `sandbox rm ` | Remove file | +| `sandbox download ` | Download as archive | +| `sandbox upload ` | Upload and extract archive | | `sandbox snapshot` | Manage snapshots | | `sandbox execution` | View execution history | +| `sandbox runtime list` | List available runtimes | +| `sandbox env ` | Manage environment variables | **Alias:** `sb` (e.g., `agentuity cloud sb list`) @@ -143,7 +151,9 @@ agentuity cloud sandbox delete sbx_abc123 --confirm # Skip prompt ## File Operations -Copy files to and from sandboxes. +### Copy Files + +Copy individual files or directories to and from sandboxes. ```bash agentuity cloud sandbox cp @@ -160,6 +170,124 @@ agentuity cloud sandbox cp sbx_abc123:/workspace/output.json ./output.json agentuity cloud sandbox cp ./src sbx_abc123:/workspace/src ``` +### List Files + +List files and directories in a sandbox. + +```bash +agentuity cloud sandbox files [path] [options] +``` + +| Option | Description | +|--------|-------------| +| `-l, --long` | Show permissions and timestamps | +| `--json` | JSON output | + +**Alias:** `lsf` + +```bash +# List root directory +agentuity cloud sandbox files sbx_abc123 + +# List specific directory +agentuity cloud sandbox files sbx_abc123 /workspace/src + +# Long format with details +agentuity cloud sandbox files sbx_abc123 -l +``` + +### Create Directory + +```bash +agentuity cloud sandbox mkdir [options] +``` + +| Option | Description | +|--------|-------------| +| `-p, --parents` | Create parent directories as needed | + +```bash +# Create a directory +agentuity cloud sandbox mkdir sbx_abc123 /workspace/output + +# Create nested directories +agentuity cloud sandbox mkdir sbx_abc123 /workspace/data/processed -p +``` + +### Remove Files and Directories + +```bash +# Remove a file +agentuity cloud sandbox rm + +# Remove a directory +agentuity cloud sandbox rmdir [options] +``` + +| Option | Description | +|--------|-------------| +| `-r, --recursive` | Remove directory and all contents | + +```bash +# Remove a file +agentuity cloud sandbox rm sbx_abc123 /workspace/temp.txt + +# Remove empty directory +agentuity cloud sandbox rmdir sbx_abc123 /workspace/old + +# Remove directory with contents +agentuity cloud sandbox rmdir sbx_abc123 /workspace/cache -r +``` + +### Download Archive + +Download sandbox files as a compressed archive. + +```bash +agentuity cloud sandbox download [options] +``` + +| Option | Description | +|--------|-------------| +| `--path ` | Download specific directory (defaults to root) | +| `--format ` | Archive format: `tar.gz` (default) or `zip` | + +**Alias:** `dl` + +```bash +# Download entire sandbox +agentuity cloud sandbox download sbx_abc123 ./backup.tar.gz + +# Download as zip +agentuity cloud sandbox download sbx_abc123 ./backup.zip --format zip + +# Download specific directory +agentuity cloud sandbox download sbx_abc123 ./src.tar.gz --path /workspace/src +``` + +### Upload Archive + +Upload and extract an archive into a sandbox. + +```bash +agentuity cloud sandbox upload [options] +``` + +| Option | Description | +|--------|-------------| +| `--path ` | Destination path (defaults to root) | +| `--format ` | Archive format (auto-detected if not specified) | + +**Alias:** `ul` + +```bash +# Upload and extract to root +agentuity cloud sandbox upload sbx_abc123 ./project.tar.gz + +# Upload to specific directory +agentuity cloud sandbox upload sbx_abc123 ./deps.zip --path /workspace/node_modules +``` + ## Snapshot Commands Manage sandbox snapshots for creating pre-configured environments. @@ -317,6 +445,59 @@ agentuity cloud sandbox get sbx_abc123 --json agentuity cloud sandbox snapshot list --json ``` +## Runtime Commands + +List available sandbox runtimes. + +### List Runtimes + +```bash +agentuity cloud sandbox runtime list [options] +``` + +| Option | Description | +|--------|-------------| +| `--limit ` | Max results (default: 50, max: 100) | +| `--offset ` | Pagination offset | +| `--json` | JSON output | + +```bash +# List available runtimes +agentuity cloud sandbox runtime list + +# With pagination +agentuity cloud sandbox runtime list --limit 10 --offset 20 +``` + +**Alias:** `rt` (e.g., `agentuity cloud sandbox rt list`) + +## Environment Variables + +Manage environment variables on a running sandbox. + +```bash +agentuity cloud sandbox env [KEY=VALUE...] [options] +``` + +| Option | Description | +|--------|-------------| +| `--delete ` | Delete variable (repeatable, alias: `-d`) | +| `--json` | JSON output | + +```bash +# Set an environment variable +agentuity cloud sandbox env sbx_abc123 MY_VAR=value + +# Set multiple variables +agentuity cloud sandbox env sbx_abc123 VAR1=value1 VAR2=value2 + +# Delete a variable +agentuity cloud sandbox env sbx_abc123 --delete MY_VAR + +# Delete multiple variables +agentuity cloud sandbox env sbx_abc123 -d VAR1 -d VAR2 +``` + ## Next Steps - [Sandbox Overview](/Sandbox): Understand sandbox concepts, security defaults, and when to use each execution mode diff --git a/content/Reference/CLI/storage.mdx b/content/Reference/CLI/storage.mdx index da5d811b..60bf04f6 100644 --- a/content/Reference/CLI/storage.mdx +++ b/content/Reference/CLI/storage.mdx @@ -143,63 +143,6 @@ agentuity cloud s3 delete **In agents:** Use Bun's `s3` API (`import { s3 } from "bun"`). See [Object Storage (S3)](/Storage/object). -## Object Storage (Legacy) - -The `cloud obj` commands provide bucket-based object management. For new projects, consider using `cloud s3` instead. - -### Interactive REPL - -```bash -agentuity cloud obj repl -``` - -### Upload a File - -```bash -# Upload from file path -agentuity cloud obj put uploads images/logo.png @./logo.png - -# Store JSON directly -agentuity cloud obj put assets config.json '{"api":"https://api.example.com"}' - -# With custom content type -agentuity cloud obj put backups db.sql @~/backup.sql --content-type application/sql -``` - -### Download a File - -```bash -agentuity cloud obj get uploads images/logo.png -agentuity cloud obj get assets config.json -``` - -### Delete a File - -```bash -agentuity cloud obj delete uploads old-image.png -``` - -### Generate Public URL - -```bash -# Permanent URL -agentuity cloud obj url uploads images/logo.png - -# Temporary URL (expires in 1 hour) -agentuity cloud obj url uploads private-doc.pdf --expires 3600 - -# 5-minute presigned URL -agentuity cloud obj presigned backups db.sql --expires 300 -``` - -### List Buckets and Files - -```bash -agentuity cloud obj list-buckets -agentuity cloud obj list-keys uploads -agentuity cloud obj ls assets # Using alias -``` - ## Vector Storage Search and inspect vector embeddings.