Skip to content

EXAMPLES.md

Latest commit

 

History

History
104 lines (76 loc) · 2.69 KB

EXAMPLES.md

File metadata and controls

104 lines (76 loc) · 2.69 KB

Examples

This file is auto-generated from metadata in examples/*.ts. Do not edit this file manually. Run yarn generate:examples-md instead.

Runnable examples live in examples/.

Table of Contents

Devbox From Blueprint (Run Command, Shutdown)

Use case: Create a devbox from a blueprint, run a command, validate output, and cleanly tear everything down.

Tags: devbox, blueprint, commands, cleanup

Workflow

  • Create a blueprint
  • Create a devbox from the blueprint
  • Execute a command in the devbox
  • Validate exit code and stdout
  • Shutdown devbox and delete blueprint

Prerequisites

  • RUNLOOP_API_KEY

Run

yarn tsn -T examples/devbox-from-blueprint-lifecycle.ts

Test

yarn test:examples

Source: examples/devbox-from-blueprint-lifecycle.ts

Devbox Snapshot and Resume

Use case: Create a devbox, snapshot its disk, resume from the snapshot, and demonstrate that changes in the original devbox do not affect the clone.

Tags: devbox, snapshot, resume, cleanup

Workflow

  • Create a devbox
  • Write a file to the devbox
  • Create a disk snapshot
  • Create a new devbox from the snapshot
  • Modify the file on the original devbox
  • Verify the clone has the original content
  • Shutdown both devboxes and delete the snapshot

Prerequisites

  • RUNLOOP_API_KEY

Run

yarn tsn -T examples/devbox-snapshot-resume.ts

Test

yarn test:examples

Source: examples/devbox-snapshot-resume.ts

MCP Hub + Claude Code + GitHub

Use case: Connect Claude Code running in a devbox to GitHub tools through MCP Hub without exposing raw GitHub credentials to the devbox.

Tags: mcp, devbox, github, commands, cleanup

Workflow

  • Create an MCP config for GitHub
  • Store GitHub token as a Runloop secret
  • Launch a devbox with MCP Hub wiring
  • Install Claude Code and register MCP endpoint
  • Run a Claude prompt through MCP tools
  • Shutdown devbox and clean up cloud resources

Prerequisites

  • RUNLOOP_API_KEY
  • GITHUB_TOKEN (GitHub PAT with repo scope)
  • ANTHROPIC_API_KEY

Run

GITHUB_TOKEN=ghp_xxx ANTHROPIC_API_KEY=sk-ant-xxx yarn tsn -T examples/mcp-github-tools.ts

Test

yarn test:examples

Source: examples/mcp-github-tools.ts