@machinen/runtime 0.3.3 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API.md +9445 -2148
- package/README.md +8 -10
- package/dist/index.d.ts +1788 -107
- package/dist/index.js +13044 -4861
- package/dist/index.js.map +1 -1
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -28,19 +28,17 @@ If you want a CLI rather than a library, see
|
|
|
28
28
|
npm i @machinen/runtime
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
You also need a VMM
|
|
32
|
-
(`@machinen/
|
|
33
|
-
`@machinen/
|
|
34
|
-
automatically as an optional dependency. If you'd rather install it
|
|
35
|
-
explicitly:
|
|
31
|
+
You also need a native package with the VMM and host tools. The matching one
|
|
32
|
+
for your host (`@machinen/native-arm64-darwin`,
|
|
33
|
+
`@machinen/native-arm64-linux`, or `@machinen/native-x64-linux`) is pulled in
|
|
34
|
+
automatically as an optional dependency. If you'd rather install it explicitly:
|
|
36
35
|
|
|
37
36
|
```bash
|
|
38
|
-
npm i @machinen/
|
|
37
|
+
npm i @machinen/native-arm64-darwin # or native-arm64-linux / native-x64-linux
|
|
39
38
|
```
|
|
40
39
|
|
|
41
|
-
First boot fetches the kernel + base rootfs from
|
|
42
|
-
release
|
|
43
|
-
CLI](https://cli.github.com/) (`gh auth login`).
|
|
40
|
+
First boot fetches the matching kernel + base rootfs from the public
|
|
41
|
+
companion GitHub release over HTTPS; no `gh auth login` is needed.
|
|
44
42
|
|
|
45
43
|
## A taste
|
|
46
44
|
|
|
@@ -48,7 +46,7 @@ CLI](https://cli.github.com/) (`gh auth login`).
|
|
|
48
46
|
import { boot } from "@machinen/runtime";
|
|
49
47
|
|
|
50
48
|
const vm = await boot({
|
|
51
|
-
image: "./rootfs-debian-arm64.tar.gz",
|
|
49
|
+
image: "./rootfs-debian-arm64.tar.gz", // or rootfs-debian-amd64.tar.gz on amd64 Linux
|
|
52
50
|
cmd: ["/bin/sh"],
|
|
53
51
|
});
|
|
54
52
|
|