@machinen/cli 0.3.4 → 0.4.1

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.
Files changed (4) hide show
  1. package/README.md +12 -18
  2. package/dist/cli.js +4576 -2208
  3. package/dist/cli.js.map +1 -1
  4. package/package.json +5 -4
package/README.md CHANGED
@@ -10,8 +10,8 @@ or a script — without writing any TypeScript.
10
10
  start a long-running service and detach so your shell can exit.
11
11
  - **Hand a running process off to another machine.** Snapshot it on
12
12
  host A, copy the bundle, restore on host B. The process resumes
13
- exactly where it left off — same heap, same connections, same
14
- counters in memory.
13
+ from the saved VM state — same heap and counters in memory, with
14
+ host port forwards declared again on the target.
15
15
  - **Clone a warmed-up VM into a sibling.** `fork` snapshots and
16
16
  restores in one step; both copies run independently from a shared
17
17
  heap. Useful for branching test fixtures, parallel exploration, or
@@ -32,7 +32,7 @@ or a script — without writing any TypeScript.
32
32
 
33
33
  For end-to-end recipes (provisioning images, mounts, networking,
34
34
  snapshot patterns), see the [guides](../../docs/). For the full
35
- command-by-command reference, see [API.md](./API.md).
35
+ command reference, see [API.md](./API.md).
36
36
 
37
37
  ## Install
38
38
 
@@ -43,25 +43,19 @@ npm i -g @machinen/cli # or globally if you prefer it on PATH
43
43
 
44
44
  Both `machinen` and the shorter alias `mn` are installed.
45
45
 
46
- The matching VMM binary (`@machinen/vmm-arm64-darwin` or
47
- `@machinen/vmm-arm64-linux`) is pulled in via optional dependencies.
48
- Each VMM package also ships a sibling `gvproxy` binary that the
49
- runtime auto-spawns to provide guest networking — no system packages
50
- required.
46
+ The matching native package (`@machinen/native-arm64-darwin`,
47
+ `@machinen/native-arm64-linux`, or `@machinen/native-x64-linux`) is pulled in
48
+ via optional dependencies. It ships the VMM plus sibling host tools such as
49
+ `gvproxy`, `mke2fs`, and `mksquashfs`, so no system packages are required.
51
50
 
52
- First boot fetches the kernel + base rootfs from a private GitHub
53
- release, so make sure you've authenticated [GitHub
54
- CLI](https://cli.github.com/):
55
-
56
- ```bash
57
- gh auth login
58
- ```
51
+ First boot fetches the matching kernel + base rootfs from the public
52
+ companion GitHub release over HTTPS; no GitHub authentication is needed.
59
53
 
60
54
  ## At a glance
61
55
 
62
56
  ```bash
63
57
  npx machinen boot ./image.tar.gz # boot a provisioned image
64
- npx machinen boot --name worker --detached ./image.tar.gz
58
+ npx machinen boot --name worker --detach ./image.tar.gz
65
59
  # ... and reach it from another shell:
66
60
  npx machinen ls
67
61
  npx machinen exec worker -- ps aux
@@ -78,8 +72,8 @@ by process.
78
72
 
79
73
  ## Reference
80
74
 
81
- The full command surface — every flag, every error mode, the cache
82
- layout, the env vars — is in [API.md](./API.md).
75
+ The command reference — main flags, cache layout, and env vars — is in
76
+ [API.md](./API.md).
83
77
 
84
78
  ## License
85
79