oomi-ai 0.1.0 → 0.2.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.
package/README.md CHANGED
@@ -1,25 +1,112 @@
1
1
  # oomi-ai
2
2
 
3
- CLI to install Oomi agent instructions into an OpenClaw workspace.
3
+ CLI to install Oomi agent instructions and skills into OpenClaw, plus sync personas to the Oomi backend registry.
4
4
 
5
5
  ## Install
6
6
  ```
7
+ pnpm add -g oomi-ai
8
+ ```
9
+
10
+ Fallback:
11
+ ```
7
12
  npm install -g oomi-ai
8
13
  ```
9
14
 
10
15
  ## Usage
16
+
17
+ Install agent instructions only:
11
18
  ```
12
19
  oomi init
13
20
  ```
14
21
 
22
+ Install agent instructions + Oomi skill:
23
+ ```
24
+ oomi openclaw install
25
+ ```
26
+
27
+ Start managed gateway bridge (OpenClaw host -> Oomi broker):
28
+ ```
29
+ oomi openclaw bridge \
30
+ --broker-http https://your-signaling-service.example.com \
31
+ --broker-ws wss://your-signaling-service.example.com/cable \
32
+ --pair-code ABCD2345
33
+ ```
34
+
35
+ Bridge env config:
36
+ - `OOMI_CHAT_BROKER_HTTP_URL`
37
+ - `OOMI_CHAT_BROKER_DEVICE_WS_URL`
38
+
39
+ Pair + bootstrap bridge automatically from Oomi web backend:
40
+ ```
41
+ oomi openclaw pair --app-url https://your-oomi-app.vercel.app --device-id my-openclaw-mac --detach
42
+ ```
43
+
44
+ `--app-url` must be reachable from the OpenClaw host. If OpenClaw runs on a different machine/network, do not use `localhost` unless tunneled.
45
+
46
+ This prints:
47
+ - `Connect code: <device-id>`
48
+ - `Connect URL: https://.../?connect=managed://<device-id>&sessionKey=...`
49
+ - A copy-ready block for the user:
50
+ - `Oomi Connect Ready`
51
+ - `Code: ...`
52
+ - `Link: ...`
53
+
54
+ Agent-intent mapping (recommended):
55
+ - If user says `Connect yourself to Oomi. Use app URL https://www.oomi.ai.`
56
+ - Run:
57
+ - `curl -fsSL https://www.oomi.ai/install.sh | bash`
58
+ - or `pnpm add -g oomi-ai@latest` (`npm install -g oomi-ai@latest` fallback)
59
+ - `oomi openclaw pair --app-url https://www.oomi.ai --detach`
60
+ - If already paired and reconnecting:
61
+ - `oomi openclaw bridge --detach`
62
+
63
+ Important distinction:
64
+ - `pairCode` is one-time and used internally by the pair/bootstrap flow.
65
+ - `connect code` is the stable device id used by browser connect (`managed://<device-id>`).
66
+
67
+ Sync personas from the repo into the backend registry:
68
+ ```
69
+ oomi personas sync --backend-url http://localhost:3001
70
+ ```
71
+
72
+ Create a new persona (and sync it):
73
+ ```
74
+ oomi personas create chef --name "Oomi Chef" --summary "Cooking ideas and nutrition guidance"
75
+ ```
76
+
15
77
  Optional flags:
16
78
  ```
17
79
  oomi init --workspace /path/to/openclaw/workspace
18
80
  oomi init --agents-file /path/to/AGENTS.md
81
+ oomi openclaw install --skills-dir /path/to/openclaw/skills
82
+ oomi openclaw bridge --broker-ws wss://.../cable --device-token <token>
83
+ oomi openclaw pair --app-url https://your-oomi-app.vercel.app --no-start
84
+ oomi openclaw pair --app-url https://your-oomi-app.vercel.app --detach
85
+ oomi openclaw pair --app-url https://your-oomi-app.vercel.app --json
86
+ oomi personas sync --root /path/to/oomi
87
+ oomi personas create creator --status active --chat-session agent:main:webchat:channel:oomi-creator
19
88
  ```
20
89
 
21
- By default, the CLI writes to:
22
- - `$OPENCLAW_WORKSPACE/AGENTS.md` (if set), otherwise
23
- - `~/.openclaw/workspace/AGENTS.md`
90
+ Defaults:
91
+ - Agent instructions are written to `$OPENCLAW_WORKSPACE/AGENTS.md` (if set), otherwise `~/.openclaw/workspace/AGENTS.md`.
92
+ - Skills are installed to `~/.openclaw/skills` and `~/clawd/skills` if present.
93
+
94
+ Restart OpenClaw after running `oomi init` or `oomi openclaw install`.
24
95
 
25
- Restart OpenClaw after running this command.
96
+ ## Update Notifications
97
+ - `oomi` checks npm for a newer `oomi-ai` version on normal commands (cached, best-effort).
98
+ - When an update is available it prints:
99
+ - `pnpm add -g oomi-ai@latest`
100
+ - fallback: `npm install -g oomi-ai@latest`
101
+ - Optional env controls:
102
+ - `OOMI_SKIP_UPDATE_CHECK=1` disables checks
103
+ - `OOMI_UPDATE_CHECK_INTERVAL_MS=<ms>` changes check interval
104
+ - `OOMI_UPDATE_CHECK_TIMEOUT_MS=<ms>` changes network timeout
105
+
106
+ ## Package Audit + Publish (pnpm)
107
+ ```
108
+ cd <repo-root>/packages/oomi-ai
109
+ pnpm check
110
+ pnpm publish --dry-run --no-git-checks --access public
111
+ pnpm publish --access public
112
+ ```
@@ -10,3 +10,25 @@ Use inline tags like:
10
10
  - [look:camera], [look:left], [look:right], [look:up], [look:down]
11
11
 
12
12
  Aliases allowed (if needed): wave -> Waving, walk -> Walking, idle -> Idle, sit/sitting -> Sitting Idle
13
+
14
+ ## Oomi Connect Flow
15
+
16
+ If the user asks to connect OpenClaw to Oomi voice/web:
17
+
18
+ 1. Refresh bootstrap/update first:
19
+ - `curl -fsSL https://www.oomi.ai/install.sh | bash`
20
+ 2. Ensure `oomi-ai` is installed (`pnpm add -g oomi-ai@latest`).
21
+ - Fallback: `npm install -g oomi-ai@latest`
22
+ 3. Run:
23
+ - `oomi openclaw pair --app-url https://www.oomi.ai --detach`
24
+ 4. If already paired and reconnecting:
25
+ - `oomi openclaw bridge --detach`
26
+ 5. If user provides an app URL (for example "Connect yourself to Oomi. Use app URL <URL>."):
27
+ - Use that URL directly in the pair command.
28
+ - Example: `oomi openclaw pair --app-url <URL> --detach`
29
+ 6. Return this exact result format to the user:
30
+ - `Oomi Connect Ready`
31
+ - `Code: ...`
32
+ - `Link: ...`
33
+
34
+ Do not ask users to paste gateway IP/token/password when managed connect is available.