@spheron/sandbox 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+Spheron Sandbox SDK
+Copyright 2026 Spheron
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,165 @@
-# Temporary Holding Version
+# @spheron/sandbox
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Run commands and move files on a Spheron Agent GPU Sandbox from your own code. It is the same sandbox an AI agent gets through the Spheron connector, driven with a GPU VM API key instead.
+
+A sandbox is a real GPU VM you keep for hours: files, packages and models stay on it between jobs, and your own SSH key keeps working the whole time. A VM takes a few minutes to boot, so it suits training, fine-tuning, evals and long jobs, not one-off snippets.
+
+Zero dependencies. Node 18 or later, Bun and Deno. It is an ES module: CommonJS code loads it with `require('@spheron/sandbox')` on Node 20.19+ and 22.12+, or with `await import('@spheron/sandbox')` on older Node.
+
+```bash
+bun add @spheron/sandbox
+```
+
+## Quickstart
+
+Create a GPU VM API key in the dashboard (Settings, API Keys) and export it:
+
+```bash
+export SPHERON_API_KEY=sai_pk_...
+```
+
+```ts
+import { Sandbox } from '@spheron/sandbox';
+
+// Cheapest H100 offer up to $3/hour that can take the sandbox. Waits until commands can run (a few minutes).
+const sandbox = await Sandbox.create({ gpu: 'h100', gpuCount: 1, maxHourlyPrice: 3 });
+
+const gpu = await sandbox.commands.run('nvidia-smi --query-gpu=name,memory.total --format=csv');
+console.log(gpu.output);
+
+await sandbox.files.write('/root/train.py', trainScript);
+const job = await sandbox.commands.start('cd /root && python train.py', { timeoutSec: 6 * 3600 });
+for await (const chunk of job.stream()) process.stdout.write(chunk);
+
+const metrics = await sandbox.files.read('/root/metrics.json');
+
+await sandbox.terminate(); // billing stops
+```
+
+The instance bills at its normal hourly price from the moment it runs until you stop or terminate it.
+
+## Creating a sandbox
+
+`Sandbox.create()` lists offers, deploys the cheapest match with the sandbox on and waits for it. When an offer is sold out or cannot take the sandbox, it moves on to the next one (nothing is created or billed for a refused offer).
+
+| Option | Default | |
+|---|---|---|
+| `gpu` | any | GPU model, one word: `h100`, `a100`, `l40s`, `rtx4090` |
+| `gpuCount` | any | GPUs per instance |
+| `maxHourlyPrice` | none | Most to pay per hour for the whole instance, in USD. Set it. |
+| `spot` | `false` | Spot offers only: cheaper, and can be reclaimed at any time |
+| `regions`, `providers` | all | Narrow the search |
+| `offer` | | Deploy this exact offer (from `Sandbox.findOffers()`) |
+| `operatingSystem` | Ubuntu with CUDA | Matched against the offer's options |
+| `teamId` | your only team | Required when the key reaches several teams |
+| `sshKeyId` / `sshPublicKey` | first saved key | Your own access to the VM. Always installed. |
+| `volumeIds` | | Volumes to attach at launch |
+| `waitUntilReady` | `true` | Return as soon as the create is accepted when `false` |
+| `readyTimeoutMs` | 20 min | |
+| `onStatus` | | Called with `deploying`, `installing`, `ready` |
+
+To choose by hand:
+
+```ts
+const offers = await Sandbox.findOffers({ gpu: 'a100', maxHourlyPrice: 2 });
+console.table(offers.map((o) => ({ provider: o.provider, gpus: o.gpuCount, region: o.region, price: o.price })));
+const sandbox = await Sandbox.create({ offer: offers[0] });
+```
+
+Pick one up again later, from any process:
+
+```ts
+const sandbox = await Sandbox.connect('6650c0ffee...'); // the deployment id
+```
+
+## Commands
+
+Commands run with bash as the VM's login user, with sudo. Output is stdout and stderr together, up to 1 MB per command. The full log stays on the VM at `logPath`, readable with `sandbox.files.read(r.logPath)`.
+
+A finished command's `status` is `done` when it exits 0 and `failed` for a non-zero exit (with its `exitCode`), a `timeoutSec` kill (`error` is `timed out`) or a lost command.
+
+```ts
+// Wait for it to finish. Killed after timeoutSec (default 600).
+const r = await sandbox.commands.run('pip install -r requirements.txt', { cwd: '/root/app', timeoutSec: 1800 });
+r.exitCode; r.output;
+
+// Throw CommandExitError unless it exits 0.
+await sandbox.commands.run('pytest -q', { check: true });
+
+// Live output.
+await sandbox.commands.run('python bench.py', { onOutput: (chunk) => process.stdout.write(chunk) });
+
+// Background job (up to 24 hours): returns at once.
+const job = await sandbox.commands.start('python train.py', { env: { WANDB_MODE: 'offline' } });
+job.id;                          // keep it to come back later: sandbox.commands.get(id)
+await job.wait({ timeoutMs: 60_000 }).catch(() => {}); // stop waiting, the job keeps running
+await job.kill();                // stops it and everything it started
+```
+
+A command sent while the VM is briefly unreachable stays `queued` and runs once the sandbox is back.
+
+## Files
+
+```ts
+await sandbox.files.write('/root/config.yaml', 'lr: 0.001\n');
+await sandbox.files.write('/root/run.sh', script, { mode: '0755' });
+const text = await sandbox.files.read('/root/out.txt');
+const bytes = await sandbox.files.readBytes('/root/plot.png');
+const entries = await sandbox.files.list('/root');   // [{ name, type, size }]
+await sandbox.files.exists('/root/checkpoint.pt');
+```
+
+File operations run as root, and a file you write belongs to the VM's login user. Missing parent directories are created. Each read or write moves up to 5 MB, and an account moves at most two files at once (the SDK waits and retries). Download datasets and models on the VM itself:
+
+```ts
+await sandbox.commands.run('huggingface-cli download meta-llama/Llama-3.1-8B --local-dir /root/model', { timeoutSec: 3600 });
+```
+
+## Lifecycle
+
+```ts
+await sandbox.status();        // { state: 'ready', reachable: true, deploymentRunning: true, ... }
+await sandbox.info();          // the deployment: status, IP, sshCommand, hourlyRate, ...
+await sandbox.stop();          // keeps the disk, bills only storage; waits until the provider has stopped it
+await sandbox.start();         // waits until it runs and the sandbox is reachable; retries while the provider is not ready
+await sandbox.terminate();     // deleted with its disk; after the offer's minimum runtime (usually 20 min)
+await sandbox.removeSandbox(); // uninstall the sandbox program, keep the VM
+```
+
+## Errors
+
+Every error extends `SpheronError`. API refusals are `SpheronApiError` with `status`, `code` and `requestId`.
+
+| Error | When |
+|---|---|
+| `AuthenticationError` | Missing or wrong key, or an Inference API key |
+| `NotFoundError` | No such instance, no sandbox on it, or a teammate deployed it (only the deployer can use a sandbox) |
+| `InstanceNotRunningError` | The VM is stopped, terminated or failed |
+| `SandboxNotReadyError` | Still installing |
+| `SandboxUnreachableError` | Spheron cannot reach the VM. `recovery.command`, run over SSH on the VM, brings it back. From `commands.run()` it also has `commandId`: the command stays queued and runs once the VM is back, unless you kill it |
+| `SandboxFailedError` | The install failed or the VM died while waiting. Has `deploymentId` and, when it helps, `recoveryCommand` |
+| `CommandExitError` | `check: true` and a non-zero exit |
+| `NoOfferError` | No offer matched, or every one tried was refused (`attempts` says why) |
+| `TimeoutError` | A wait in the SDK ran out. The VM or command keeps running |
+
+Once an instance exists, every error about it carries its `deploymentId`: it bills until it is terminated.
+
+Safe requests that hit a dropped connection or a 502/503/504 are retried with backoff (`maxRetries`, default 3). A 429 is retried for up to 90 seconds, waiting as long as the API asks. File transfers already queue in the SDK: at most 2 run at once per sandbox, the server's limit.
+
+## Configuration
+
+```ts
+Sandbox.create({ apiKey: 'sai_pk_...', baseUrl: 'https://app.spheron.ai', maxRetries: 3, requestTimeoutMs: 90_000, pollIntervalMs: 2000 });
+```
+
+`apiKey` defaults to `SPHERON_API_KEY`, `baseUrl` to `SPHERON_BASE_URL`. `requestTimeoutMs` bounds one HTTP request; waits such as `waitUntilReady` take their own `timeoutMs`. A key scoped to some teams or IP addresses works within that scope.
+
+## Good to know
+
+- Only the person who deployed a VM can use its sandbox. Teammates get `NotFoundError`.
+- Every command is logged with its text and exit code. Output and file contents are not.
+- The sandbox program only connects outwards to Spheron. It opens no port on the VM.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

package/dist/commands.d.ts

@@ -0,0 +1,112 @@
+import { type HttpClient } from './http.js';
+import { type CommandResult, type CommandStatus, type CommandView } from './types.js';
+export interface RunOptions {
+    /** Absolute working directory. Default: the login user's home. */
+    cwd?: string;
+    /** Extra environment variables. */
+    env?: Record<string, string>;
+    /** Kill the command after this many seconds, at most 86400. Default 600. */
+    timeoutSec?: number;
+    /** Called with each new piece of output as it arrives. */
+    onOutput?: (chunk: string) => void;
+    /** Throw CommandExitError unless the command exits 0. */
+    check?: boolean;
+    /** Stop waiting after this long; the command keeps running. Default: its timeout plus 5 minutes. */
+    waitTimeoutMs?: number;
+    signal?: AbortSignal;
+}
+export interface StartOptions {
+    cwd?: string;
+    env?: Record<string, string>;
+    /** Kill the command after this many seconds. Default 86400 (24 hours), the maximum. */
+    timeoutSec?: number;
+}
+export interface WaitOptions {
+    /** Called with each new piece of output as it arrives. */
+    onOutput?: (chunk: string) => void;
+    /** Stop waiting after this long; the command keeps running. Default: no limit. */
+    timeoutMs?: number;
+    /** Throw CommandExitError unless the command exits 0. */
+    check?: boolean;
+    signal?: AbortSignal;
+}
+/** A command on the sandbox, running or finished. Get one from `sandbox.commands.start()` or `.get()`. */
+export declare class CommandHandle {
+    private readonly http;
+    private readonly base;
+    private readonly pollIntervalMs;
+    readonly id: string;
+    private currentStatus;
+    private currentExitCode?;
+    /** Byte offset of the next output to read. */
+    private offset;
+    private output;
+    private last?;
+    /** @internal Use sandbox.commands.start() or .get(). */
+    constructor(http: HttpClient, base: string, commandId: string, pollIntervalMs: number, view?: CommandView);
+    /** Last status seen: queued, running, done, failed, killed or expired. */
+    get status(): CommandStatus;
+    /** Set once the command has exited. */
+    get exitCode(): number | undefined;
+    /** The command has finished (done, failed, killed or expired). */
+    get finished(): boolean;
+    /** Output this handle has collected so far. */
+    get outputSoFar(): string;
+    /** Takes in an answer and returns its new output. The server reads from our offset, so new output starts there. */
+    private absorb;
+    private result;
+    /** Reads the status and any new output once. With waitSec, the server holds the answer until there is some. */
+    poll(opts?: {
+        waitSec?: number;
+        signal?: AbortSignal;
+    }): Promise<string>;
+    /** New output until the command finishes, reading at most once per poll interval. */
+    private follow;
+    /**
+     * Output as it arrives, until the command finishes: first what this handle already has, then each new piece.
+     * The command keeps running if you stop iterating.
+     *
+     * ```ts
+     * for await (const chunk of handle.stream()) process.stdout.write(chunk);
+     * ```
+     */
+    stream(opts?: {
+        signal?: AbortSignal;
+    }): AsyncGenerator<string, CommandResult>;
+    /** Wait for the command to finish and return everything it printed. */
+    wait(opts?: WaitOptions): Promise<CommandResult>;
+    /** Stop the command and everything it started. Safe on one that already finished. */
+    kill(): Promise<CommandStatus>;
+}
+/** Shell commands on the sandbox. Use it as `sandbox.commands`. */
+export declare class Commands {
+    private readonly http;
+    private readonly base;
+    private readonly pollIntervalMs;
+    /** @internal */
+    constructor(http: HttpClient, base: string, pollIntervalMs: number);
+    /**
+     * Run a command with bash, as the login user (with sudo), and wait for it to finish.
+     *
+     * ```ts
+     * const r = await sandbox.commands.run('nvidia-smi');
+     * console.log(r.exitCode, r.output);
+     * ```
+     *
+     * It is killed after timeoutSec (default 600): pass a larger one, up to 86400, for long jobs, or use start().
+     * Throws SandboxUnreachableError (with the command id and a recovery command) when the instance cannot be reached;
+     * the command then stays queued and runs once the sandbox is back, unless you kill it.
+     */
+    run(command: string, opts?: RunOptions): Promise<CommandResult>;
+    /**
+     * Start a command in the background and return right away. Use the handle to stream output, wait or kill it.
+     *
+     * ```ts
+     * const job = await sandbox.commands.start('python train.py');
+     * for await (const chunk of job.stream()) process.stdout.write(chunk);
+     * ```
+     */
+    start(command: string, opts?: StartOptions): Promise<CommandHandle>;
+    /** A handle on a command started earlier, for example from another process. */
+    get(commandId: string): Promise<CommandHandle>;
+}