Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions box/guides/ai-sdk-code-interpreter.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Code Interpreter with Vercel AI SDK"
description: Add a code interpreter tool to a Vercel AI SDK chat app that runs model-written code in a fresh, isolated Upstash Box sandbox.
---

In this guide we'll add a **code interpreter** tool to a Vercel AI SDK chat app. When a user asks a question that needs computation — math, data analysis, statistics — the model writes code and sends it to a fresh `EphemeralBox` to run. The sandbox is isolated, disposable, and auto-expires when the session ends.
Expand Down
1 change: 1 addition & 0 deletions box/guides/code-review-agent.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Build a Code Review Agent"
description: Build an automated code review agent with Upstash Box that clones a repo, analyzes the PR diff, and returns structured findings with severity.
---

In this guide, we're building a code review agent (like CodeRabbit or Greptile) with Upstash Box. We clone a repo, inspect the PR diff, and return structured findings with severity and suggested fixes.
Expand Down
1 change: 1 addition & 0 deletions box/guides/crabbox-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Running Tests with Crabbox"
description: Run your test suite in a clean cloud environment with Crabbox, a CLI that executes commands inside a remote Upstash Box.
---

[Crabbox](https://crabbox.sh) is a CLI tool that runs commands inside a remote box from your local machine. This guide shows how to use it with Upstash Box to run your test suite in a clean cloud environment without touching your local setup.
Expand Down
1 change: 1 addition & 0 deletions box/guides/hermes-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Hermes Setup"
description: Set up the Hermes agent inside an Upstash Box over SSH, install it, and configure an init script for automatic restarts.
---

This guide walks you through setting up [Hermes](https://github.com/NousResearch/hermes-agent) inside an Upstash Box.
Expand Down
1 change: 1 addition & 0 deletions box/guides/openclaw-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "OpenClaw Setup"
description: Set up OpenClaw inside an Upstash Box, forward its dashboard over an SSH tunnel, and keep the gateway running with an init script.
---

This guide walks you through setting up [OpenClaw](https://docs.openclaw.ai) inside an Upstash Box.
Expand Down
1 change: 1 addition & 0 deletions box/guides/remote-development.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Remote Development"
description: Run any dev server inside an Upstash Box and access it locally over SSH port forwarding, or share it with a public URL.
---

Upstash Box supports full remote development workflows. By forwarding ports over SSH, you can run any web server inside a box and access it in your local browser exactly as if it were running on your machine. You can also expose it to the internet with a public URL for sharing or collaboration.
Expand Down
1 change: 1 addition & 0 deletions box/guides/tanstack-ai-file-editor.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "AI File Editor with TanStack AI"
description: Build an AI file editor with TanStack AI that runs model-written code on uploaded files inside a disposable Upstash Box sandbox.
---

An `EphemeralBox` gives you exactly two capabilities: **code execution** and **file operations**. That turns out to be all you need to hand an AI agent a real, disposable computer. This guide uses both. The model writes the code, and a single tool moves files in and out of the sandbox to run it against.
Expand Down
1 change: 1 addition & 0 deletions box/guides/web-scraping-playwright.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Scrape Dynamic Websites with Playwright"
description: Scrape JavaScript-heavy sites by running Playwright and Chromium inside an Upstash Box, then pull the structured results back.
---

In this guide, we use Upstash Box to run [Playwright](https://playwright.dev) against a JavaScript-heavy site, scrape structured data from it, and pull the results back to our own server. Because a Box is a real Linux container rather than a restricted serverless runtime, Chromium and its system dependencies install and run exactly like they would on your laptop.
Expand Down
1 change: 1 addition & 0 deletions box/overall/agent.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Agent"
description: Configure a built-in coding agent like Claude Code, Codex, or OpenCode in an Upstash Box and run or stream tasks with typed output.
---

**For every box, you can configure a built-in agent like Claude Code, Codex or OpenCode**. It has access to the filesystem, git, and shell commands and should simulate running an Agent on your own computer.
Expand Down
1 change: 1 addition & 0 deletions box/overall/attach-headers.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Attach Headers"
description: Inject secret HTTP headers into a box's outbound HTTPS requests with Upstash Box attach headers, keeping API keys out of the container.
---

`attachHeaders` lets you inject HTTP headers into outbound HTTPS requests from a box without the secrets ever entering the container. This is useful for API keys, bearer tokens, and other credentials that should not be readable by code running inside the box.
Expand Down
1 change: 1 addition & 0 deletions box/overall/custom-agent.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "How to Add a Custom Agent"
description: Bring your own agent process to an Upstash Box with a custom harness, streaming output back through the box-sse-v1 protocol.
---

Custom agents let you bring your own agent process to an Upstash Box. The box still provides the same sandbox, filesystem, shell, git, logs, streaming, and console experience, but your code decides how to call the model and how to produce output.
Expand Down
1 change: 1 addition & 0 deletions box/overall/ephemeral-box.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Ephemeral Box"
description: EphemeralBox is a lightweight, short-lived Upstash Box sandbox with instant creation and auto-expiry for quick exec and file tasks.
---

`EphemeralBox` is a lightweight, short-lived sandbox that provides only **exec** and **file** operations. It's designed for quick, disposable compute tasks where a full Box (with agent, git, snapshots, etc.) is unnecessary.
Expand Down
1 change: 1 addition & 0 deletions box/overall/files.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Filesystem"
description: Upload, write, read, list, and download files inside an Upstash Box using its isolated per-box filesystem API.
---

Every box has its own isolated filesystem. Upload, write, read, list, and download files inside the box.
Expand Down
1 change: 1 addition & 0 deletions box/overall/git.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Git"
description: Clone repositories, inspect diffs, commit, push branches, and open pull requests from inside an Upstash Box with the git API.
---

Clone a repository, inspect changes, commit work, push a branch, or open a pull request from inside a box.
Expand Down
1 change: 1 addition & 0 deletions box/overall/how-it-works.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Box Basics"
description: "How Upstash Box works: durable, isolated containers with agent, git, shell, and filesystem, plus lifecycle, sizes, and billing."
---

Every Upstash Box is a **durable execution environment** for AI workloads. Each box is an isolated container with its own filesystem, shell, network stack, and optional coding agent. You send prompts or commands, the box executes them, and you get back structured results without managing infrastructure.
Expand Down
1 change: 1 addition & 0 deletions box/overall/keep-alive.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Keep Alive"
description: Keep an Upstash Box always on between sessions with keepAlive for servers and long-running agents, plus startup init commands.
---

When `keepAlive` is enabled, the box stays on between sessions instead of auto-pausing when idle. Use it when you need a box to remain continuously available, for example to host a server, keep a long-running agent ready, or preserve an always-on development environment.
Expand Down
1 change: 1 addition & 0 deletions box/overall/network-policy.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Network Policy"
description: "Control a box's outbound network access with Upstash Box network policies: allow-all, deny-all, or custom domain and CIDR rules."
---

Network policies control outbound network access from a box.
Expand Down
1 change: 1 addition & 0 deletions box/overall/preview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Public URLs"
description: Expose ports from an Upstash Box with public URLs, optionally protected by bearer token or basic authentication.
---

Expose ports from a box with public URLs. Each public URL maps to a specific port and can optionally require authentication.
Expand Down
1 change: 1 addition & 0 deletions box/overall/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Quickstart"
description: "Get started with Upstash Box: install the SDK, create an isolated cloud container, configure an AI agent, and run your first task."
---

**Upstash Box lets you give your AI agents a computer.**
Expand Down
1 change: 1 addition & 0 deletions box/overall/schedules.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Schedules"
description: Schedule recurring shell commands or agent prompts inside an Upstash Box with cron expressions, webhooks, and schedule management.
---

Create recurring tasks that run on a cron schedule inside a box. You can schedule shell commands or agent prompts. Available on both `box.schedule` and `ephemeralBox.schedule`.
Expand Down
1 change: 1 addition & 0 deletions box/overall/security.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Security & Secrets"
description: How Upstash Box isolates containers and handles secrets, including environment variables, attach headers, and blocked variables.
---

## Isolation
Expand Down
1 change: 1 addition & 0 deletions box/overall/shell.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Shell"
description: Run shell commands and code snippets in an Upstash Box's full Linux shell through the SDK or an interactive SSH connection.
---

Every box has a full Linux shell and runs on Debian by default.
Expand Down
1 change: 1 addition & 0 deletions box/overall/snapshots.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Snapshots"
description: Capture and restore Upstash Box state with snapshots to checkpoint workspaces, reuse prepared environments, and fan out boxes.
---

Snapshots let you capture and duplicate box state. Use **snapshots** to save a point-in-time checkpoint you can restore later.
Expand Down
1 change: 1 addition & 0 deletions box/overall/use-cases.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Use Cases"
description: "Upstash Box use cases: durable agent servers, multi-agent orchestration, and parallel model testing with isolated cloud sandboxes."
---

The idea behind Upstash Box is simple: **give AI its own computer**. Your agent gets a full, isolated cloud environment it can control. Run commands, write files, or execute code independent of any user device. Freeze a box anytime, and continue days or even weeks later with perfect resumability.
Expand Down
Loading