Skip to content
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion box/guides/ai-sdk-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Vercel AI SDK Tools"
title: "Vercel AI SDK Code Interpreter and Shell Tools"
sidebarTitle: "Vercel AI SDK Tools"
description: "Give Vercel AI SDK agents a cloud sandbox to run Python, JavaScript, and shell commands, manage files, and share app previews with Upstash Box."
---

A Box is a real Linux container: shell, filesystem, ports, and a browser. This guide wraps those capabilities as [Vercel AI SDK](https://ai-sdk.dev) tools, so any `streamText` call can hand the model a computer instead of just a chat window.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/browser-use.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Scheduled Browser Use Agent"
title: "Run a Browser Use Agent on a Daily Schedule"
sidebarTitle: "Scheduled Browser Use Agent"
description: "Run a Browser Use agent inside Upstash Box and schedule it with cron. The example agent reads Hacker News every morning and saves a report to the box."
---

Run a [Browser Use](https://browser-use.com) agent inside Upstash Box. The agent, the browser, and the files it writes all live in one box, and a schedule runs it again on a cron.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/claude-managed-agents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Claude Managed Agents"
title: "Self-Hosted Sandboxes for Claude Managed Agents"
sidebarTitle: "Claude Managed Agents"
description: "Use Upstash Box as a self-hosted sandbox for Claude Managed Agents. Claude runs on Anthropic's side, and each session's bash commands and file edits run in its own box."
---

Run [Claude Managed Agents](https://platform.claude.com/docs/en/managed-agents/overview) sessions in Upstash Box. Claude runs on Anthropic's side, and each session gets its own box where its bash commands and file edits run. Web search and web fetch still run on Anthropic's side.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/code-review-agent.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Build a Code Review Agent"
title: "Build an AI Code Review Agent for Pull Requests"
sidebarTitle: "Build a Code Review Agent"
description: "Build an AI code review agent with Upstash Box that clones a repo, inspects the pull request diff, and returns structured findings with severity and suggested fixes."
---

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/copilotkit.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "In-App Coding Agent with CopilotKit"
sidebarTitle: "CopilotKit"
description: "Add a CopilotKit chat to your Next.js app where each user talks to a coding agent running in their own Upstash Box, next to its shell and files."
---

Put a [CopilotKit](https://www.copilotkit.ai) chat in your Next.js app where each user talks to a coding agent running in their own Upstash Box.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/eve-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Vercel Eve Sandboxes"
title: "Vercel Eve Sandbox for Isolated Code Execution"
sidebarTitle: "Vercel Eve Sandboxes"
description: "Use @upstash/agentkit-eve to run Vercel Eve agent code in Upstash Box, with deny-all egress, setup baked into a snapshot, and one box per session."
---

[Eve](https://eve.dev) is Vercel's agent framework. It gives an agent a code-execution sandbox through a single `agent/sandbox.ts` file, and the provider behind that file is swappable.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/herdr-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Herdr Plugin Setup"
title: "Run Herdr Coding Agents in Isolated Cloud Sandboxes"
sidebarTitle: "Herdr Plugin Setup"
description: "Use the Upstash Box plugin for Herdr to run coding agents from a Git worktree in their own box, then apply their changes locally as a reviewed patch."
---

[Herdr](https://herdr.dev) is a terminal workspace manager for coding agents. The Upstash Box plugin
Expand Down
4 changes: 3 additions & 1 deletion box/guides/hermes-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Hermes Setup"
title: "Self-Host Hermes Agent in a Cloud Sandbox"
sidebarTitle: "Hermes Setup"
description: "Install the Hermes agent by Nous Research in a keep-alive Upstash Box over SSH, and restart it automatically with an init script."
---

This guide walks you through setting up [Hermes](https://github.com/NousResearch/hermes-agent) inside an Upstash Box.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/langchain-deep-agents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "LangChain Deep Agents"
title: "Sandbox Backend for LangChain Deep Agents"
sidebarTitle: "LangChain Deep Agents"
description: "Use langchain-upstash-box as a Deep Agents sandbox backend, so the agent's shell and file tools run in an isolated Upstash Box instead of on your machine."
---

In this guide we'll give a [LangChain Deep Agent](https://docs.langchain.com/oss/python/deepagents/overview) a real computer to work in. The [`langchain-upstash-box`](https://pypi.org/project/langchain-upstash-box/) package wraps an Upstash Box (a secure, isolated cloud container with a full Linux shell, filesystem, git, and a runtime) as a Deep Agents [sandbox backend](https://docs.langchain.com/oss/python/deepagents/backends). The agent's shell and file tools then run inside the box instead of on your machine.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/nextjs-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Next.js Setup"
title: "Run a Next.js App in a Cloud Sandbox with a Public URL"
sidebarTitle: "Next.js Setup"
description: "Scaffold a Next.js app inside an Upstash Box, run the dev server, and open it from any browser through a public URL, all with the Box SDK."
---

This guide walks you through scaffolding a [Next.js](https://nextjs.org) app inside an Upstash Box and opening it in your browser through a public URL, without using an agent.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/openai-agents-api.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "OpenAI Agents API"
title: "Self-Hosted Sandboxes for the OpenAI Agents API"
sidebarTitle: "OpenAI Agents API"
description: "Use Upstash Box as a self-hosted sandbox for the OpenAI Agents API. The agent runs on OpenAI's side, and each session's commands run in its own box."
---

Run the commands of the [OpenAI Agents API](https://developers.openai.com/api/docs/guides/agents-api/environments/self-hosted) in Upstash Box. The agent runs on OpenAI's side, and each session gets its own box where its commands run. Every box includes the Codex CLI, so there is nothing to install.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/openclaw-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "OpenClaw Setup"
title: "Self-Host an Always-On OpenClaw Agent in the Cloud"
sidebarTitle: "OpenClaw Setup"
description: "Install OpenClaw in a keep-alive Upstash Box over SSH, open its dashboard from your machine, and restart it automatically with an init script."
---

This guide walks you through setting up [OpenClaw](https://docs.openclaw.ai) inside an Upstash Box.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/pi-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Pi Setup"
title: "Run Pi Agent Tool Calls in a Remote Sandbox"
sidebarTitle: "Pi Setup"
description: "Use the @upstash/box-pi extension to run every Pi tool call in an Upstash Box, while the agent and your model API keys stay on your machine."
---

This guide walks you through using [Pi](https://pi.dev) with the [`@upstash/box-pi`](https://pi.dev/packages/@upstash/box-pi) extension ([npm](https://www.npmjs.com/package/@upstash/box-pi)), which runs every tool call (`bash`, file I/O, and search) inside an Upstash Box. The agent and your model API keys stay on your machine; only tool execution happens in the box.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/remote-development.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Remote Development"
title: "Remote Development Environment for AI Coding Agents"
sidebarTitle: "Remote Development"
description: "Turn an Upstash Box into a remote development environment. Your app runs in the cloud, you open it in your browser, and your coding agent does the work."
---

A box is a Linux machine in the cloud with a filesystem, a shell, git and a runtime. This guide turns one into a development environment: your app runs in the box, you open it in your browser, and your coding agent does the work.
Expand Down
1 change: 1 addition & 0 deletions box/guides/t3-code-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Host T3 Code in a Remote Sandbox"
sidebarTitle: "T3 Code Setup"
description: "Run T3 Code in an Upstash Box and open it from any browser or phone. The box sleeps when you are away and wakes when you open the URL again."
---

This guide walks you through running [T3 Code](https://t3.codes) inside an Upstash Box and opening it from any browser or phone. The agent works in the box, the box sleeps when you are away, and it wakes when you open the URL again.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/tanstack-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "TanStack AI Coding Agents"
title: "Run TanStack AI Coding Agents in a Cloud Sandbox"
sidebarTitle: "TanStack AI Coding Agents"
description: "Run TanStack AI coding agents like Claude Code, Codex, and OpenCode inside Upstash Box with the native @tanstack/ai-sandbox-upstash-box provider."
---

[TanStack AI](https://tanstack.com/ai) ships a native Upstash Box sandbox provider. Install `@tanstack/ai-sandbox-upstash-box`, point it at your API key, and a coding agent driven by `chat()` runs inside a Box with a real filesystem, shell, background processes, preview URLs, and snapshots. No glue code.
Expand Down
4 changes: 3 additions & 1 deletion box/guides/web-scraping-playwright.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Playwright Web Scraping"
title: "Playwright Web Scraping with a Cloud Browser"
sidebarTitle: "Playwright Web Scraping"
description: "Scrape JavaScript-heavy sites with the managed headless Chromium in Upstash Box. Extract structured data through the SDK, then connect Playwright over CDP."
---

Every box can come with its own browser. Create one with `browser: true` and you get a managed, headless Chromium that boots on first use. Nothing to install, no `apt-get`, no Chromium binary to keep up to date.
Expand Down
30 changes: 15 additions & 15 deletions llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4720,7 +4720,7 @@ Use `uploadRoute()` when a route needs an `input` schema for data the browser se

`GET` on the route serves its constraints as JSON. That is what fills [`accept` and `constraints`](/docs/blob/uploads/upload-client#useupload) on the hook, and it lets the hook refuse an oversized file before any request leaves the browser. The server still enforces the same limits at `begin`. The document and its caching are on [Constraints](/docs/blob/uploads/constraints#in-the-browser).

# Vercel AI SDK Tools
# Vercel AI SDK Code Interpreter and Shell Tools
Source: https://upstash.com/docs/box/guides/ai-sdk-setup

A Box is a real Linux container: shell, filesystem, ports, and a browser. This guide wraps those capabilities as [Vercel AI SDK](https://ai-sdk.dev) tools, so any `streamText` call can hand the model a computer instead of just a chat window.
Expand Down Expand Up @@ -5070,7 +5070,7 @@ export const runCode = tool({
* [Public URLs](/docs/box/overall/preview) for authenticating the URLs `exposePort` hands out.
* [Snapshots](/docs/box/overall/snapshots) to boot each conversation from a pre-installed environment.

# Scheduled Browser Use Agent
# Run a Browser Use Agent on a Daily Schedule
Source: https://upstash.com/docs/box/guides/browser-use

Run a [Browser Use](https://browser-use.com) agent inside Upstash Box. The agent, the browser, and the files it writes all live in one box, and a schedule runs it again on a cron.
Expand Down Expand Up @@ -5232,7 +5232,7 @@ box.delete()
* [Connect over CDP](/docs/box/overall/browser/connect) to drive the box browser with Browser Use from your own machine.
* [Browser](/docs/box/overall/browser/overview) for the SDK's own `observe`, `act`, and `extract`.

# Claude Managed Agents
# Self-Hosted Sandboxes for Claude Managed Agents
Source: https://upstash.com/docs/box/guides/claude-managed-agents

Run [Claude Managed Agents](https://platform.claude.com/docs/en/managed-agents/overview) sessions in Upstash Box. Claude runs on Anthropic's side, and each session gets its own box where its bash commands and file edits run. Web search and web fetch still run on Anthropic's side.
Expand Down Expand Up @@ -5435,7 +5435,7 @@ Values you pass in `env` are readable by the agent; use `attachHeaders` for cred
* **`This API key is not scoped to a workspace`**: create the API key inside a workspace.
* **Commands never run**: check `/workspace/home/worker.log` in the session's box.

# Build a Code Review Agent
# Build an AI Code Review Agent for Pull Requests
Source: https://upstash.com/docs/box/guides/code-review-agent

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 Expand Up @@ -5857,7 +5857,7 @@ The system prompt is set when the conversation starts and stays for the rest of
* **No tool cards with OpenCode**: the OpenCode harness streams only text, so the chat shows the reply without the tool calls.
* **Box limit reached**: the error comes from `Box.create`. Delete unused boxes in the console or upgrade your plan.

# Vercel Eve Sandboxes
# Vercel Eve Sandbox for Isolated Code Execution
Source: https://upstash.com/docs/box/guides/eve-setup

[Eve](https://eve.dev) is Vercel's agent framework. It gives an agent a code-execution sandbox through a single `agent/sandbox.ts` file, and the provider behind that file is swappable.
Expand Down Expand Up @@ -6078,7 +6078,7 @@ The same package carries the rest of AgentKit for Eve: long-term memory, searcha
* [Network policies](/docs/box/overall/network-policy) for what Box's allow lists can express.
* [Snapshots](/docs/box/overall/snapshots) for building and restoring the boxes behind a sandbox environment.

# Herdr Plugin Setup
# Run Herdr Coding Agents in Isolated Cloud Sandboxes
Source: https://upstash.com/docs/box/guides/herdr-setup

[Herdr](https://herdr.dev) is a terminal workspace manager for coding agents. The Upstash Box plugin
Expand Down Expand Up @@ -6229,7 +6229,7 @@ again.
</Card>
</CardGroup>

# Hermes Setup
# Self-Host Hermes Agent in a Cloud Sandbox
Source: https://upstash.com/docs/box/guides/hermes-setup

This guide walks you through setting up [Hermes](https://github.com/NousResearch/hermes-agent) inside an Upstash Box.
Expand Down Expand Up @@ -6290,7 +6290,7 @@ hermes gateway run > gateway.log 2>&1 &

This command runs automatically whenever the box starts, so your gateway is always available without manual intervention.

# LangChain Deep Agents
# Sandbox Backend for LangChain Deep Agents
Source: https://upstash.com/docs/box/guides/langchain-deep-agents

In this guide we'll give a [LangChain Deep Agent](https://docs.langchain.com/oss/python/deepagents/overview) a real computer to work in. The [`langchain-upstash-box`](https://pypi.org/project/langchain-upstash-box/) package wraps an Upstash Box (a secure, isolated cloud container with a full Linux shell, filesystem, git, and a runtime) as a Deep Agents [sandbox backend](https://docs.langchain.com/oss/python/deepagents/backends). The agent's shell and file tools then run inside the box instead of on your machine.
Expand Down Expand Up @@ -6399,7 +6399,7 @@ result = sandbox.execute("sleep 5 && echo done", timeout=30)

To see everything else a box can do, like snapshots, git, previews, and schedules, check the [Box quickstart](/docs/box/overall/quickstart).

# Next.js Setup
# Run a Next.js App in a Cloud Sandbox with a Public URL
Source: https://upstash.com/docs/box/guides/nextjs-setup

This guide walks you through scaffolding a [Next.js](https://nextjs.org) app inside an Upstash Box and opening it in your browser through a public URL, without using an agent.
Expand Down Expand Up @@ -6492,7 +6492,7 @@ Open the URL in your browser and your Next.js app loads. See [Public URLs](/docs
```
</Note>

# OpenAI Agents API
# Self-Hosted Sandboxes for the OpenAI Agents API
Source: https://upstash.com/docs/box/guides/openai-agents-api

Run the commands of the [OpenAI Agents API](https://developers.openai.com/api/docs/guides/agents-api/environments/self-hosted) in Upstash Box. The agent runs on OpenAI's side, and each session gets its own box where its commands run. Every box includes the Codex CLI, so there is nothing to install.
Expand Down Expand Up @@ -6664,7 +6664,7 @@ Box.create({
* **Script waits and prints nothing**: the executor didn't connect. Check `/workspace/home/executor.log` in the box.
* **`missing required scope api.agents.environments.connect`**: `OPENAI_EXECUTOR_KEY` must be an environment key, not a regular API key.

# OpenClaw Setup
# Self-Host an Always-On OpenClaw Agent in the Cloud
Source: https://upstash.com/docs/box/guides/openclaw-setup

This guide walks you through setting up [OpenClaw](https://docs.openclaw.ai) inside an Upstash Box.
Expand Down Expand Up @@ -6766,7 +6766,7 @@ ssh -F /dev/null -o ControlMaster=no -o ServerAliveInterval=15 -o ServerAliveCou

The most likely causes are a local `~/.ssh/config` entry (e.g. a stale `ControlMaster` socket or conflicting options) being applied to the connection, or a NAT/firewall on your network dropping idle TCP connections. The flags above bypass your local SSH config and keep the connection active with periodic keepalives.

# Pi Setup
# Run Pi Agent Tool Calls in a Remote Sandbox
Source: https://upstash.com/docs/box/guides/pi-setup

This guide walks you through using [Pi](https://pi.dev) with the [`@upstash/box-pi`](https://pi.dev/packages/@upstash/box-pi) extension ([npm](https://www.npmjs.com/package/@upstash/box-pi)), which runs every tool call (`bash`, file I/O, and search) inside an Upstash Box. The agent and your model API keys stay on your machine; only tool execution happens in the box.
Expand Down Expand Up @@ -6886,7 +6886,7 @@ Each Pi session gets one box, and the box follows the session:
* **Duplicate flag or tool errors** mean two copies of the extension are loaded. Run `pi list` and `pi uninstall` one of them.
* **Pushes not appearing on GitHub?** Branch sync needs `gh auth login` and a github.com remote.

# Remote Development
# Remote Development Environment for AI Coding Agents
Source: https://upstash.com/docs/box/guides/remote-development

A box is a Linux machine in the cloud with a filesystem, a shell, git and a runtime. This guide turns one into a development environment: your app runs in the box, you open it in your browser, and your coding agent does the work.
Expand Down Expand Up @@ -7121,7 +7121,7 @@ setsid nohup t3 serve --host 0.0.0.0 --port 3773 --base-dir /workspace/home/.t3
* After a reset, install T3 Code again (step 3). A snapshot restore brings your projects and pairing back as they were.
* If a thread says "Claude could not authenticate", the sign-in from step 4 is missing. Sign in and start a new thread.

# TanStack AI Coding Agents
# Run TanStack AI Coding Agents in a Cloud Sandbox
Source: https://upstash.com/docs/box/guides/tanstack-setup

[TanStack AI](https://tanstack.com/ai) ships a native Upstash Box sandbox provider. Install `@tanstack/ai-sandbox-upstash-box`, point it at your API key, and a coding agent driven by `chat()` runs inside a Box with a real filesystem, shell, background processes, preview URLs, and snapshots. No glue code.
Expand Down Expand Up @@ -7401,7 +7401,7 @@ try {
* [Harnesses](https://tanstack.com/ai/latest/docs/sandbox/harnesses) for running Codex, Grok Build, or any ACP agent instead.
* [Snapshots](/docs/box/overall/snapshots) and [preview URLs](/docs/box/overall/preview) for what the box does underneath.

# Playwright Web Scraping
# Playwright Web Scraping with a Cloud Browser
Source: https://upstash.com/docs/box/guides/web-scraping-playwright

Every box can come with its own browser. Create one with `browser: true` and you get a managed, headless Chromium that boots on first use. Nothing to install, no `apt-get`, no Chromium binary to keep up to date.
Expand Down
Loading
Loading