@cloudflare/sandbox 0.0.0-037c848

package/CHANGELOG.md

@@ -0,0 +1,45 @@
+# @cloudflare/sandbox
+
+## 0.0.7
+
+### Patch Changes
+
+- [`d1c7c99`](https://github.com/cloudflare/sandbox-sdk/commit/d1c7c99df6555eff71bcd59852e4b8eed2ad8cb6) Thanks [@threepointone](https://github.com/threepointone)! - fix file operations
+
+## 0.0.6
+
+### Patch Changes
+
+- [#9](https://github.com/cloudflare/sandbox-sdk/pull/9) [`24f5470`](https://github.com/cloudflare/sandbox-sdk/commit/24f547048d5a26137de4656cea13d83ad2cc0b43) Thanks [@ItsWendell](https://github.com/ItsWendell)! - fix baseUrl for stub and stub forwarding
+
+## 0.0.5
+
+### Patch Changes
+
+- [#5](https://github.com/cloudflare/sandbox-sdk/pull/5) [`7c15b81`](https://github.com/cloudflare/sandbox-sdk/commit/7c15b817899e4d9e1f25747aaf439e5e9e880d15) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Make package ready for deployment
+
+## 0.0.4
+
+### Patch Changes
+
+- [`c0d9d33`](https://github.com/cloudflare/sandbox-sdk/commit/c0d9d3396badee1eab45e6b4a73d48957f31409b) Thanks [@threepointone](https://github.com/threepointone)! - actually work
+
+- [`444d2da`](https://github.com/cloudflare/sandbox-sdk/commit/444d2dafde9a0f190e50c879b0e768da1b289b51) Thanks [@threepointone](https://github.com/threepointone)! - add experimental label
+
+## 0.0.3
+
+### Patch Changes
+
+- [`2b087c4`](https://github.com/cloudflare/sandbox-sdk/commit/2b087c40a29697c20dad19b4e3b8512f5d404bd3) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix worker unable to find container port
+
+## 0.0.2
+
+### Patch Changes
+
+- [`52f02f0`](https://github.com/cloudflare/sandbox-sdk/commit/52f02f0625ef9f8eac695e51f93fa79651c0206d) Thanks [@threepointone](https://github.com/threepointone)! - readFile
+
+## 0.0.1
+
+### Patch Changes
+
+- [`f786c3c`](https://github.com/cloudflare/sandbox-sdk/commit/f786c3cee6bd9777bd74918ae9fdf381aa99f913) Thanks [@threepointone](https://github.com/threepointone)! - Release!

package/Dockerfile

@@ -0,0 +1,16 @@
+# syntax=docker/dockerfile:1
+
+FROM oven/bun:latest
+# Set destination for COPY
+WORKDIR /app
+
+# Install git
+RUN apt-get update && apt-get install -y git
+
+COPY container_src/* ./
+# RUN bun install
+
+EXPOSE 3000
+# Run
+CMD ["bun", "index.ts"]
+

package/README.md

@@ -0,0 +1,65 @@
+## @cloudflare/sandbox
+
+> **⚠️ Experimental** - This library is currently experimental and we're actively seeking feedback. Please try it out and let us know what you think!
+
+A library to spin up a sandboxed environment.
+
+First, setup your wrangler.json to use the sandbox:
+
+```jsonc
+{
+  // ...
+  "containers": [
+    {
+      "class_name": "Sandbox",
+      "image": "./node_modules/@cloudflare/sandbox/Dockerfile",
+      "name": "sandbox"
+    }
+  ],
+  "durable_objects": {
+    "bindings": [
+      {
+        "class_name": "Sandbox",
+        "name": "Sandbox"
+      }
+    ]
+  },
+  "migrations": [
+    {
+      "new_sqlite_classes": ["Sandbox"],
+      "tag": "v1"
+    }
+  ]
+}
+```
+
+Then, export the Sandbox class in your worker:
+
+```ts
+export { Sandbox } from "@cloudflare/sandbox";
+```
+
+You can then use the Sandbox class in your worker:
+
+```ts
+import { getSandbox } from "@cloudflare/sandbox";
+
+export default {
+  async fetch(request: Request, env: Env) {
+    const sandbox = getSandbox(env.Sandbox, "my-sandbox");
+    return sandbox.exec("ls", ["-la"]);
+  },
+};
+```
+
+### Methods:
+
+- `exec(command: string, args: string[], options?: { stream?: boolean })`: Execute a command in the sandbox.
+- `gitCheckout(repoUrl: string, options: { branch?: string; targetDir?: string; stream?: boolean })`: Checkout a git repository in the sandbox.
+- `mkdir(path: string, options: { recursive?: boolean; stream?: boolean })`: Create a directory in the sandbox.
+- `writeFile(path: string, content: string, options: { encoding?: string; stream?: boolean })`: Write content to a file in the sandbox.
+- `readFile(path: string, options: { encoding?: string; stream?: boolean })`: Read content from a file in the sandbox.
+- `deleteFile(path: string, options?: { stream?: boolean })`: Delete a file from the sandbox.
+- `renameFile(oldPath: string, newPath: string, options?: { stream?: boolean })`: Rename a file in the sandbox.
+- `moveFile(sourcePath: string, destinationPath: string, options?: { stream?: boolean })`: Move a file from one location to another in the sandbox.
+- `ping()`: Ping the sandbox.