@slicervm/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Alex Ellis, OpenFaaS Ltd 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# @slicervm/sdk
+
+TypeScript SDK for the [Slicer](https://slicervm.com) VM control-plane API.
+
+Mirrors the [Go SDK](https://github.com/slicervm/sdk) semantically, with a grouped TypeScript shape inspired by `@e2b` and `modal`. The top-level `SlicerClient` exposes `hostGroups`, `vms`, and `secrets` namespaces; per-VM operations live on a `VM` handle returned from `client.vms.create()` / `client.vms.attach()`.
+
+Supports Unix socket and HTTP(S) transports.
+
+```ts
+import { SlicerClient, GiB } from '@slicervm/sdk';
+
+const client = new SlicerClient({ baseURL: '/Users/me/slicer-mac/slicer.sock' });
+
+const vm = await client.vms.create(
+  'sbox',
+  { cpus: 1, ramBytes: GiB(1) },
+  { wait: 'agent', waitTimeoutSec: 60 },
+);
+
+const result = await vm.execBuffered({ command: 'uname', args: ['-a'] });
+console.log(result.stdout);
+
+await vm.fs.writeFile('/tmp/hello.txt', 'hi');
+console.log((await vm.fs.readFile('/tmp/hello.txt')).toString());
+
+await vm.delete();
+```
+
+## Status
+
+Pre-release. See `ts-plan.md`.