@miomioos/mio-agent 0.2.2

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/README.md ADDED
@@ -0,0 +1,69 @@
1
+ # mio-agent
2
+
3
+ Mio Agent — background daemon for MioIsland's Slock-like AI workspace (private use).
4
+
5
+ This is an internal package for the MioMioOS ecosystem. It runs on a developer
6
+ machine, bridges Claude Code / Codex sessions to the MioMioOS server, and powers
7
+ the agent inbox + action runtime consumed by MioIsland clients.
8
+
9
+ > **Internal package.** Published for installation convenience only.
10
+ > No external support, no public API guarantees, no semver promises.
11
+ > If you are not on the MioMioOS team, this is not for you.
12
+
13
+ ## Run in terminal mode (no global install — npx-cached)
14
+
15
+ You do NOT need a global install or a downloaded GitHub binary to run the daemon
16
+ in pure-terminal mode. `npx` fetches + caches the package and launches the bin:
17
+
18
+ ```bash
19
+ # 1. Pair this machine with prod (https://mio.wdao.chat) via QR + phone approval:
20
+ npx @miomioos/mio-agent@latest login
21
+
22
+ # 2. Run the daemon in the foreground (terminal mode), Ctrl-C to stop:
23
+ npx @miomioos/mio-agent@latest start
24
+ ```
25
+
26
+ `npx` caches the resolved version, so subsequent `start` invocations launch
27
+ without re-downloading. The published tarball ships only the compiled JS runtime
28
+ (~0.2 MB packed) — the 36 MB SEA release binaries are for the MioIsland-managed
29
+ install path and are NOT included here.
30
+
31
+ - **terminal mode** (`start` / `run`): the daemon runs in YOUR terminal/foreground;
32
+ you own the process lifecycle. Good for dogfooding and headless boxes.
33
+ - **MioIsland-managed mode** (`install --background --version <semver>`): a
34
+ version-pinned LaunchAgent/systemd service managed by the MioIsland app, which
35
+ fetches the signed SEA release artifact. See the runbook below.
36
+
37
+ Requires Node.js >= 20.
38
+
39
+ ## Install (global)
40
+
41
+ ```bash
42
+ npm install -g @miomioos/mio-agent
43
+ ```
44
+
45
+ ## Quick commands
46
+
47
+ ```bash
48
+ mio-agent --help # list available subcommands
49
+ mio-agent login # pair this machine with the MioMioOS server
50
+ mio-agent doctor # diagnose runtime / auth / gateway health
51
+ mio-agent install # install the daemon as a launchd / systemd service
52
+ mio-agent run # foreground run (debugging)
53
+ ```
54
+
55
+ After `mio-agent install`, the daemon runs in the background and reconnects
56
+ to the MioMioOS gateway automatically.
57
+
58
+ ## Lifecycle / runbook
59
+
60
+ See `docs/daemon-install-runbook.md` in the source repository for the full
61
+ install / uninstall / upgrade / log-collection lifecycle, including the
62
+ launchd plist layout, log paths, and rollback steps.
63
+
64
+ For incident playbooks, gateway recovery, and the version pinning policy,
65
+ see the operations notes in MioServer admin.
66
+
67
+ ## License
68
+
69
+ UNLICENSED — internal use within MioMioOS only.