Skip to content

Updates #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
parteeksingh24 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updates #331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions content/Reference/CLI/debugging.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down
32 changes: 13 additions & 19 deletions content/Reference/CLI/deployment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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": {
Copy link
Member

@jhaynie jhaynie Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to put "domains": [] to show that you can configure domains? i believe that is now the default when i create a new project

"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

Expand Down
8 changes: 8 additions & 0 deletions content/Reference/CLI/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion content/Reference/CLI/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
183 changes: 182 additions & 1 deletion content/Reference/CLI/sandbox.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@ All sandbox commands require the `cloud` prefix. For example: `agentuity cloud s
| `sandbox delete <id>` | Destroy sandbox |
| `sandbox exec <id> -- <cmd>` | Execute in existing sandbox |
| `sandbox cp` | Copy files to/from sandbox |
| `sandbox files <id>` | List files in sandbox |
| `sandbox mkdir <id> <path>` | Create directory |
| `sandbox rmdir <id> <path>` | Remove directory |
| `sandbox rm <id> <path>` | Remove file |
| `sandbox download <id> <output>` | Download as archive |
| `sandbox upload <id> <archive>` | Upload and extract archive |
| `sandbox snapshot` | Manage snapshots |
| `sandbox execution` | View execution history |
| `sandbox runtime list` | List available runtimes |
| `sandbox env <id>` | Manage environment variables |

Copy link
Member

@jhaynie jhaynie Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have build and generate commands that will come out in tonights release

**Alias:** `sb` (e.g., `agentuity cloud sb list`)

Expand Down Expand Up @@ -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 <source> <destination>
Expand All @@ -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 <sandbox-id> [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 <sandbox-id> <path> [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 <sandbox-id> <path>

# Remove a directory
agentuity cloud sandbox rmdir <sandbox-id> <path> [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 <sandbox-id> <output-file> [options]
```

| Option | Description |
|--------|-------------|
| `--path <path>` | Download specific directory (defaults to root) |
| `--format <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 <sandbox-id> <archive-file> [options]
```

| Option | Description |
|--------|-------------|
| `--path <path>` | Destination path (defaults to root) |
| `--format <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.
Expand Down Expand Up @@ -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 <n>` | Max results (default: 50, max: 100) |
| `--offset <n>` | 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 <sandbox-id> [KEY=VALUE...] [options]
```

| Option | Description |
|--------|-------------|
| `--delete <key>` | 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
Expand Down
57 changes: 0 additions & 57 deletions content/Reference/CLI/storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,63 +143,6 @@ agentuity cloud s3 delete <storage-id>

**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.
Expand Down