Cloudflare Sandbox

https://sandbox.cloudflare.com
Admin
Cloudflare Sandbox allows users to execute commands, manage files, run services, and expose them via...
Tokens:1,168
Snippets:28
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Cloudflare Sandbox SDK

Source: https://sandbox.cloudflare.com

Install the Cloudflare Sandbox SDK using npm. This is the first step to integrating the SDK into your project.

```bash
npm i @cloudflare/sandbox
```

--------------------------------

### Manual Git Clone and NPM Test Commands

Source: https://sandbox.cloudflare.com

These are example shell commands for manually cloning a Git repository and running npm tests, which can be executed within a sandbox environment.

```bash
$ git clone https://github.com/cloudflare/agents
```

```bash
$ npm test
```

--------------------------------

### Run Interactive Terminal Command

Source: https://sandbox.cloudflare.com

Execute a command to start an interactive terminal session with specific emulation and handling.

```bash
opencode run 'fix the failing t
```

--------------------------------

### Cloudflare Sandbox Worker Example

Source: https://sandbox.cloudflare.com

This Worker demonstrates how to use Cloudflare Sandboxes to clone a repository and run tests. It requires the Sandbox class to be exported and the Sandbox environment variable to be configured.

```typescript
import { getSandbox } from "@cloudflare/sandbox";

// Export the Sandbox class in your Worker
export { Sandbox } from "@cloudflare/sandbox";

export default {
  async fetch(request: Request, env: Env) {
    const sandbox = getSandbox(env.Sandbox, "test-env");
    // Clone a repository
    await sandbox.gitCheckout(
      "https://github.com/cloudflare/agents"
    );
    // Run tests
    const testResult = await sandbox.exec("npm test");
    return new Response(
      JSON.stringify({
        tests: testResult.exitCode === 0 
          ? "passed"
          : "failed",
        output: testResult.stdout,
      })
    );
  },
};
```

--------------------------------

### Mount Cloud Storage

Source: https://sandbox.cloudflare.com

Mount S3-compatible buckets as local filesystem paths for data access. Example shows mounting R2/S3/GCS to /workspace/data.

```bash
R2 / S3
/workspace/data
```

--------------------------------

### File Operations in Cloudflare Sandbox

Source: https://sandbox.cloudflare.com

Demonstrates creating directories, writing files, and reading files within the Cloudflare sandbox environment using the @cloudflare/sandbox SDK. This is useful for setting up project structures and managing file content programmatically.

```typescript
import { getSandbox } from '@cloudflare/sandbox';

export default {
  async fetch(request: Request, env: Env) {
    const sandbox = getSandbox(env.Sandbox, 'user-123');

    // Create a project structure
    await sandbox.mkdir('/workspace/project/src', {
      recursive: true
    });

    // Write files
    await sandbox.writeFile(
     '/workspace/project/package.json',
      JSON.stringify({ name: 'my-app', version: '1.0.0', });

    // Read a file back
    const content = await sandbox.readFile(
      '/workspace/project/src/package.json'
    );
    return Response.json({ content });
  }
};
```

--------------------------------

### Add Sandbox to Docker Image

Source: https://sandbox.cloudflare.com

Integrate the standalone sandbox binary into a custom Docker image. This Dockerfile snippet copies the binary and sets it as the entrypoint.

```dockerfile
FROM your-image:tag
COPY --from=cloudflare/sandbox
/container-server/sandbox /sandbox
ENTRYPOINT ["/sandbox"]
```

--------------------------------

### Clone Git Repository

Source: https://sandbox.cloudflare.com

Use this command to clone a Git repository into the container filesystem.

```bash
git clone https://github.com/cloudflare/agents
```

--------------------------------

### Run Python Code with Time Delays

Source: https://sandbox.cloudflare.com

Execute Python code that includes time delays and prints output to the console. This snippet demonstrates a basic loop with a sleep interval.

```python
for i in range(5):
    print(f"Hello Python! On step {i}")
    time.sleep(1)
```
Tokens:
Raw