Skip to content

feat(sdk): add alpine/debian runtime variants #125

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
enesakar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(sdk): add alpine/debian runtime variants #125

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
2 changes: 1 addition & 1 deletion packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ box create \
| Flag | Description | Default |
| ------------------ | ------------------------------------------------------------------------------------------- | ----------------- |
| `--token` | Upstash Box API token | |
| `--runtime` | Runtime environment (`node`, `python`, `golang`, `ruby`, `rust`) | |
| `--runtime` | Runtime environment (`node`, `python`, `golang`, `ruby`, `rust`). Append `-alpine` for Alpine variants or `-debian` to be explicit (default). | |
| `--agent-model` | Agent model identifier | |
| `--agent-provider` | Agent provider (`claude-code`, `codex`, `opencode`) — inferred from model prefix if omitted | inferred |
| `--agent-api-key` | Agent API key — omit for Upstash-managed key, `stored` for a saved key, or a direct API key | Upstash |
Expand Down
12 changes: 11 additions & 1 deletion packages/sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,17 @@ const box = await Box.fromSnapshot("snap_abc123", { size: "medium" });

## Runtimes

`Runtime` is a string union type: `"node" | "python" | "golang" | "ruby" | "rust"`
Each runtime defaults to **Debian** (glibc, wider binary compatibility). Append `-alpine` for smaller images using musl.

| Runtime | Default (Debian) | Alpine variant |
|-------------|-------------------|--------------------|
| Node.js | `"node"` | `"node-alpine"` |
| Python | `"python"` | `"python-alpine"` |
| Go | `"golang"` | `"golang-alpine"` |
| Ruby | `"ruby"` | `"ruby-alpine"` |
| Rust | `"rust"` | `"rust-alpine"` |

You can also use explicit `-debian` suffixes (e.g. `"node-debian"`), which are equivalent to the base names.

## Examples

Expand Down
7 changes: 6 additions & 1 deletion packages/sdk/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ import type { ZodType } from "zod/v3";
/**
* Runtime environments available for boxes
*/
export type Runtime = "node" | "python" | "golang" | "ruby" | "rust";
export type Runtime =
| "node" | "node-alpine" | "node-debian"
| "python" | "python-alpine" | "python-debian"
| "golang" | "golang-alpine" | "golang-debian"
| "ruby" | "ruby-alpine" | "ruby-debian"
| "rust" | "rust-alpine" | "rust-debian";

/**
* Resource size presets for boxes.
Expand Down
Loading