milaidy 1.0.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.
Files changed (253) hide show
  1. package/LICENSE +8 -0
  2. package/README.md +538 -0
  3. package/dist/argv-CfSowvEA.js +63 -0
  4. package/dist/config-B-mboG4v.js +4 -0
  5. package/dist/eliza-CPJjgw-e.js +1491 -0
  6. package/dist/eliza.js +2192 -0
  7. package/dist/entry.js +232 -0
  8. package/dist/index.js +209 -0
  9. package/dist/links-BFKlWqSe.js +15 -0
  10. package/dist/paths-D_yh1DEJ.js +69 -0
  11. package/dist/plugins-cli-B7kSre2c.js +134 -0
  12. package/dist/program-6KwWwKKh.js +510 -0
  13. package/dist/register.agents-CPVmSjMG.js +17 -0
  14. package/dist/register.browser-B2ooXxNx.js +15 -0
  15. package/dist/register.channels-CMYQ6K6Y.js +42 -0
  16. package/dist/register.cron-D91lY1_Y.js +9 -0
  17. package/dist/register.devices-rU5I5L_y.js +13 -0
  18. package/dist/register.gateway-82SLAvw3.js +22 -0
  19. package/dist/register.hooks-B_XTBEkt.js +9 -0
  20. package/dist/register.logs-BgEGcPd8.js +10 -0
  21. package/dist/register.models-BJt9eVgZ.js +26 -0
  22. package/dist/register.nodes-B5xY1s8a.js +9 -0
  23. package/dist/register.skills-SFQqYIhg.js +10 -0
  24. package/dist/register.subclis-uF_AsbWR.js +187 -0
  25. package/dist/run-main-XODklzS-.js +56 -0
  26. package/dist/theme-DBvtuGeq.js +36 -0
  27. package/dist/utils-C1AUpp_V.js +42 -0
  28. package/dist/version-Cpn3yr5D.js +26 -0
  29. package/dist/workspace-Co3Wul2D.js +206 -0
  30. package/dist/workspace-DCA6MNVK.js +350 -0
  31. package/docs/.i18n/README.md +31 -0
  32. package/docs/.i18n/glossary.zh-CN.json +210 -0
  33. package/docs/.i18n/zh-CN.tm.jsonl +1329 -0
  34. package/docs/CNAME +1 -0
  35. package/docs/automation/cron-jobs.md +468 -0
  36. package/docs/automation/cron-vs-heartbeat.md +254 -0
  37. package/docs/automation/gmail-pubsub.md +256 -0
  38. package/docs/automation/poll.md +69 -0
  39. package/docs/automation/webhook.md +163 -0
  40. package/docs/bedrock.md +176 -0
  41. package/docs/brave-search.md +41 -0
  42. package/docs/broadcast-groups.md +442 -0
  43. package/docs/cli/acp.md +170 -0
  44. package/docs/cli/agent.md +24 -0
  45. package/docs/cli/agents.md +75 -0
  46. package/docs/cli/approvals.md +50 -0
  47. package/docs/cli/browser.md +107 -0
  48. package/docs/cli/channels.md +79 -0
  49. package/docs/cli/config.md +50 -0
  50. package/docs/cli/configure.md +33 -0
  51. package/docs/cli/cron.md +42 -0
  52. package/docs/cli/dashboard.md +16 -0
  53. package/docs/cli/devices.md +67 -0
  54. package/docs/cli/directory.md +63 -0
  55. package/docs/cli/dns.md +23 -0
  56. package/docs/cli/docs.md +15 -0
  57. package/docs/cli/doctor.md +41 -0
  58. package/docs/cli/gateway.md +199 -0
  59. package/docs/cli/health.md +21 -0
  60. package/docs/cli/hooks.md +291 -0
  61. package/docs/cli/index.md +1029 -0
  62. package/docs/cli/logs.md +24 -0
  63. package/docs/cli/memory.md +45 -0
  64. package/docs/cli/message.md +239 -0
  65. package/docs/cli/models.md +79 -0
  66. package/docs/cli/node.md +112 -0
  67. package/docs/cli/nodes.md +73 -0
  68. package/docs/cli/onboard.md +29 -0
  69. package/docs/cli/pairing.md +21 -0
  70. package/docs/cli/plugins.md +62 -0
  71. package/docs/cli/reset.md +17 -0
  72. package/docs/cli/sandbox.md +152 -0
  73. package/docs/cli/security.md +26 -0
  74. package/docs/cli/sessions.md +16 -0
  75. package/docs/cli/setup.md +29 -0
  76. package/docs/cli/skills.md +26 -0
  77. package/docs/cli/status.md +26 -0
  78. package/docs/cli/system.md +60 -0
  79. package/docs/cli/tui.md +23 -0
  80. package/docs/cli/uninstall.md +17 -0
  81. package/docs/cli/update.md +98 -0
  82. package/docs/cli/voicecall.md +34 -0
  83. package/docs/cli/webhooks.md +25 -0
  84. package/docs/concepts/agent-loop.md +146 -0
  85. package/docs/concepts/agent-workspace.md +229 -0
  86. package/docs/concepts/agent.md +122 -0
  87. package/docs/concepts/architecture.md +129 -0
  88. package/docs/concepts/channel-routing.md +114 -0
  89. package/docs/concepts/compaction.md +61 -0
  90. package/docs/concepts/context.md +159 -0
  91. package/docs/concepts/features.md +53 -0
  92. package/docs/concepts/group-messages.md +84 -0
  93. package/docs/concepts/groups.md +373 -0
  94. package/docs/concepts/markdown-formatting.md +130 -0
  95. package/docs/concepts/memory.md +546 -0
  96. package/docs/concepts/messages.md +154 -0
  97. package/docs/concepts/model-failover.md +149 -0
  98. package/docs/concepts/model-providers.md +315 -0
  99. package/docs/concepts/models.md +208 -0
  100. package/docs/concepts/multi-agent.md +376 -0
  101. package/docs/concepts/oauth.md +145 -0
  102. package/docs/concepts/plugins.md +454 -0
  103. package/docs/concepts/presence.md +102 -0
  104. package/docs/concepts/queue.md +89 -0
  105. package/docs/concepts/retry.md +69 -0
  106. package/docs/concepts/secrets.md +300 -0
  107. package/docs/concepts/session-pruning.md +122 -0
  108. package/docs/concepts/session-tool.md +193 -0
  109. package/docs/concepts/session.md +188 -0
  110. package/docs/concepts/sessions.md +10 -0
  111. package/docs/concepts/skills.md +392 -0
  112. package/docs/concepts/streaming.md +135 -0
  113. package/docs/concepts/system-prompt.md +114 -0
  114. package/docs/concepts/timezone.md +91 -0
  115. package/docs/concepts/typebox.md +289 -0
  116. package/docs/concepts/typing-indicators.md +68 -0
  117. package/docs/concepts/usage-tracking.md +35 -0
  118. package/docs/custom.css +4 -0
  119. package/docs/date-time.md +128 -0
  120. package/docs/debugging.md +162 -0
  121. package/docs/docs.json +1599 -0
  122. package/docs/environment.md +81 -0
  123. package/docs/hooks.md +876 -0
  124. package/docs/index.md +179 -0
  125. package/docs/install/ansible.md +208 -0
  126. package/docs/install/bun.md +59 -0
  127. package/docs/install/development-channels.md +75 -0
  128. package/docs/install/docker.md +567 -0
  129. package/docs/install/index.md +185 -0
  130. package/docs/install/installer.md +123 -0
  131. package/docs/install/migrating.md +192 -0
  132. package/docs/install/nix.md +96 -0
  133. package/docs/install/node.md +78 -0
  134. package/docs/install/uninstall.md +128 -0
  135. package/docs/install/updating.md +228 -0
  136. package/docs/logging.md +350 -0
  137. package/docs/multi-agent-sandbox-tools.md +395 -0
  138. package/docs/network.md +54 -0
  139. package/docs/nodes/audio.md +114 -0
  140. package/docs/nodes/camera.md +156 -0
  141. package/docs/nodes/images.md +72 -0
  142. package/docs/nodes/index.md +341 -0
  143. package/docs/nodes/location-command.md +113 -0
  144. package/docs/nodes/media-understanding.md +379 -0
  145. package/docs/nodes/talk.md +90 -0
  146. package/docs/nodes/voicewake.md +65 -0
  147. package/docs/northflank.mdx +53 -0
  148. package/docs/perplexity.md +80 -0
  149. package/docs/platforms/android.md +129 -0
  150. package/docs/platforms/digitalocean.md +262 -0
  151. package/docs/platforms/exe-dev.md +125 -0
  152. package/docs/platforms/fly.md +486 -0
  153. package/docs/platforms/gcp.md +503 -0
  154. package/docs/platforms/hetzner.md +330 -0
  155. package/docs/platforms/index.md +53 -0
  156. package/docs/platforms/ios.md +106 -0
  157. package/docs/platforms/linux.md +94 -0
  158. package/docs/platforms/mac/bundled-gateway.md +73 -0
  159. package/docs/platforms/mac/canvas.md +125 -0
  160. package/docs/platforms/mac/child-process.md +69 -0
  161. package/docs/platforms/mac/dev-setup.md +102 -0
  162. package/docs/platforms/mac/health.md +34 -0
  163. package/docs/platforms/mac/icon.md +31 -0
  164. package/docs/platforms/mac/logging.md +57 -0
  165. package/docs/platforms/mac/menu-bar.md +81 -0
  166. package/docs/platforms/mac/peekaboo.md +65 -0
  167. package/docs/platforms/mac/permissions.md +44 -0
  168. package/docs/platforms/mac/release.md +85 -0
  169. package/docs/platforms/mac/remote.md +83 -0
  170. package/docs/platforms/mac/signing.md +47 -0
  171. package/docs/platforms/mac/skills.md +33 -0
  172. package/docs/platforms/mac/voice-overlay.md +60 -0
  173. package/docs/platforms/mac/voicewake.md +67 -0
  174. package/docs/platforms/mac/webchat.md +41 -0
  175. package/docs/platforms/mac/xpc.md +61 -0
  176. package/docs/platforms/macos-vm.md +281 -0
  177. package/docs/platforms/macos.md +203 -0
  178. package/docs/platforms/oracle.md +303 -0
  179. package/docs/platforms/raspberry-pi.md +358 -0
  180. package/docs/platforms/windows.md +159 -0
  181. package/docs/plugin.md +651 -0
  182. package/docs/plugins/agent-tools.md +99 -0
  183. package/docs/plugins/manifest.md +71 -0
  184. package/docs/plugins/voice-call.md +273 -0
  185. package/docs/plugins/zalouser.md +70 -0
  186. package/docs/providers/anthropic.md +152 -0
  187. package/docs/providers/claude-max-api-proxy.md +148 -0
  188. package/docs/providers/cloudflare-ai-gateway.md +71 -0
  189. package/docs/providers/deepgram.md +93 -0
  190. package/docs/providers/glm.md +33 -0
  191. package/docs/providers/index.md +63 -0
  192. package/docs/providers/minimax.md +208 -0
  193. package/docs/providers/models.md +51 -0
  194. package/docs/providers/moonshot.md +142 -0
  195. package/docs/providers/ollama.md +223 -0
  196. package/docs/providers/openai.md +62 -0
  197. package/docs/providers/opencode.md +36 -0
  198. package/docs/providers/openrouter.md +37 -0
  199. package/docs/providers/qwen.md +53 -0
  200. package/docs/providers/synthetic.md +99 -0
  201. package/docs/providers/venice.md +267 -0
  202. package/docs/providers/vercel-ai-gateway.md +50 -0
  203. package/docs/providers/xiaomi.md +64 -0
  204. package/docs/providers/zai.md +36 -0
  205. package/docs/railway.mdx +99 -0
  206. package/docs/reference/templates/AGENTS.md +9 -0
  207. package/docs/reference/templates/BOOTSTRAP.md +3 -0
  208. package/docs/reference/templates/HEARTBEAT.md +3 -0
  209. package/docs/reference/templates/IDENTITY.md +3 -0
  210. package/docs/reference/templates/TOOLS.md +3 -0
  211. package/docs/reference/templates/USER.md +3 -0
  212. package/docs/render.mdx +165 -0
  213. package/docs/start/docs-directory.md +63 -0
  214. package/docs/start/getting-started.md +212 -0
  215. package/docs/start/milaidy.md +247 -0
  216. package/docs/start/onboarding.md +258 -0
  217. package/docs/start/pairing.md +86 -0
  218. package/docs/start/quickstart.md +81 -0
  219. package/docs/start/setup.md +149 -0
  220. package/docs/start/showcase.md +416 -0
  221. package/docs/start/wizard.md +418 -0
  222. package/docs/testing.md +368 -0
  223. package/docs/token-use.md +112 -0
  224. package/docs/tools/agent-send.md +53 -0
  225. package/docs/tools/apply-patch.md +50 -0
  226. package/docs/tools/browser-linux-troubleshooting.md +139 -0
  227. package/docs/tools/browser-login.md +68 -0
  228. package/docs/tools/browser.md +576 -0
  229. package/docs/tools/chrome-extension.md +178 -0
  230. package/docs/tools/clawhub.md +257 -0
  231. package/docs/tools/creating-skills.md +54 -0
  232. package/docs/tools/elevated.md +57 -0
  233. package/docs/tools/exec-approvals.md +246 -0
  234. package/docs/tools/exec.md +179 -0
  235. package/docs/tools/firecrawl.md +61 -0
  236. package/docs/tools/index.md +508 -0
  237. package/docs/tools/llm-task.md +115 -0
  238. package/docs/tools/reactions.md +22 -0
  239. package/docs/tools/skills-config.md +76 -0
  240. package/docs/tools/skills.md +300 -0
  241. package/docs/tools/slash-commands.md +196 -0
  242. package/docs/tools/subagents.md +151 -0
  243. package/docs/tools/thinking.md +73 -0
  244. package/docs/tools/web.md +261 -0
  245. package/docs/tui.md +159 -0
  246. package/docs/vps.md +43 -0
  247. package/docs/web/control-ui.md +221 -0
  248. package/docs/web/dashboard.md +46 -0
  249. package/docs/web/index.md +116 -0
  250. package/docs/web/webchat.md +49 -0
  251. package/milaidy.mjs +14 -0
  252. package/package.json +271 -0
  253. package/skills/.cache/catalog.json +88519 -0
@@ -0,0 +1,50 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy approvals` (exec approvals for gateway or node hosts)"
3
+ read_when:
4
+ - You want to edit exec approvals from the CLI
5
+ - You need to manage allowlists on gateway or node hosts
6
+ title: "approvals"
7
+ ---
8
+
9
+ # `milaidy approvals`
10
+
11
+ Manage exec approvals for the **local host**, **gateway host**, or a **node host**.
12
+ By default, commands target the local approvals file on disk. Use `--gateway` to target the gateway, or `--node` to target a specific node.
13
+
14
+ Related:
15
+
16
+ - Exec approvals: [Exec approvals](/tools/exec-approvals)
17
+ - Nodes: [Nodes](/nodes)
18
+
19
+ ## Common commands
20
+
21
+ ```bash
22
+ milaidy approvals get
23
+ milaidy approvals get --node <id|name|ip>
24
+ milaidy approvals get --gateway
25
+ ```
26
+
27
+ ## Replace approvals from a file
28
+
29
+ ```bash
30
+ milaidy approvals set --file ./exec-approvals.json
31
+ milaidy approvals set --node <id|name|ip> --file ./exec-approvals.json
32
+ milaidy approvals set --gateway --file ./exec-approvals.json
33
+ ```
34
+
35
+ ## Allowlist helpers
36
+
37
+ ```bash
38
+ milaidy approvals allowlist add "~/Projects/**/bin/rg"
39
+ milaidy approvals allowlist add --agent main --node <id|name|ip> "/usr/bin/uptime"
40
+ milaidy approvals allowlist add --agent "*" "/usr/bin/uname"
41
+
42
+ milaidy approvals allowlist remove "~/Projects/**/bin/rg"
43
+ ```
44
+
45
+ ## Notes
46
+
47
+ - `--node` uses the same resolver as `milaidy nodes` (id, name, ip, or id prefix).
48
+ - `--agent` defaults to `"*"`, which applies to all agents.
49
+ - The node host must advertise `system.execApprovals.get/set` (macOS app or headless node host).
50
+ - Approvals files are stored per host at `~/.milaidy/exec-approvals.json`.
@@ -0,0 +1,107 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy browser` (profiles, tabs, actions, extension relay)"
3
+ read_when:
4
+ - You use `milaidy browser` and want examples for common tasks
5
+ - You want to control a browser running on another machine via a node host
6
+ - You want to use the Chrome extension relay (attach/detach via toolbar button)
7
+ title: "browser"
8
+ ---
9
+
10
+ # `milaidy browser`
11
+
12
+ Manage Milaidy’s browser control server and run browser actions (tabs, snapshots, screenshots, navigation, clicks, typing).
13
+
14
+ Related:
15
+
16
+ - Browser tool + API: [Browser tool](/tools/browser)
17
+ - Chrome extension relay: [Chrome extension](/tools/chrome-extension)
18
+
19
+ ## Common flags
20
+
21
+ - `--url <gatewayWsUrl>`: Gateway WebSocket URL (defaults to config).
22
+ - `--token <token>`: Gateway token (if required).
23
+ - `--timeout <ms>`: request timeout (ms).
24
+ - `--browser-profile <name>`: choose a browser profile (default from config).
25
+ - `--json`: machine-readable output (where supported).
26
+
27
+ ## Quick start (local)
28
+
29
+ ```bash
30
+ milaidy browser --browser-profile chrome tabs
31
+ milaidy browser --browser-profile milaidy start
32
+ milaidy browser --browser-profile milaidy open https://example.com
33
+ milaidy browser --browser-profile milaidy snapshot
34
+ ```
35
+
36
+ ## Profiles
37
+
38
+ Profiles are named browser routing configs. In practice:
39
+
40
+ - `milaidy`: launches/attaches to a dedicated Milaidy-managed Chrome instance (isolated user data dir).
41
+ - `chrome`: controls your existing Chrome tab(s) via the Chrome extension relay.
42
+
43
+ ```bash
44
+ milaidy browser profiles
45
+ milaidy browser create-profile --name work --color "#FF5A36"
46
+ milaidy browser delete-profile --name work
47
+ ```
48
+
49
+ Use a specific profile:
50
+
51
+ ```bash
52
+ milaidy browser --browser-profile work tabs
53
+ ```
54
+
55
+ ## Tabs
56
+
57
+ ```bash
58
+ milaidy browser tabs
59
+ milaidy browser open https://docs.milaidy.ai
60
+ milaidy browser focus <targetId>
61
+ milaidy browser close <targetId>
62
+ ```
63
+
64
+ ## Snapshot / screenshot / actions
65
+
66
+ Snapshot:
67
+
68
+ ```bash
69
+ milaidy browser snapshot
70
+ ```
71
+
72
+ Screenshot:
73
+
74
+ ```bash
75
+ milaidy browser screenshot
76
+ ```
77
+
78
+ Navigate/click/type (ref-based UI automation):
79
+
80
+ ```bash
81
+ milaidy browser navigate https://example.com
82
+ milaidy browser click <ref>
83
+ milaidy browser type <ref> "hello"
84
+ ```
85
+
86
+ ## Chrome extension relay (attach via toolbar button)
87
+
88
+ This mode lets the agent control an existing Chrome tab that you attach manually (it does not auto-attach).
89
+
90
+ Install the unpacked extension to a stable path:
91
+
92
+ ```bash
93
+ milaidy browser extension install
94
+ milaidy browser extension path
95
+ ```
96
+
97
+ Then Chrome → `chrome://extensions` → enable “Developer mode” → “Load unpacked” → select the printed folder.
98
+
99
+ Full guide: [Chrome extension](/tools/chrome-extension)
100
+
101
+ ## Remote browser control (node host proxy)
102
+
103
+ If the Gateway runs on a different machine than the browser, run a **node host** on the machine that has Chrome/Brave/Edge/Chromium. The Gateway will proxy browser actions to that node (no separate browser control server required).
104
+
105
+ Use `gateway.nodes.browser.mode` to control auto-routing and `gateway.nodes.browser.node` to pin a specific node if multiple are connected.
106
+
107
+ Security + remote setup: [Browser tool](/tools/browser), [Remote access](/gateway/remote), [Tailscale](/gateway/tailscale), [Security](/gateway/security)
@@ -0,0 +1,79 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy channels` (accounts, status, login/logout, logs)"
3
+ read_when:
4
+ - You want to add/remove channel accounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage)
5
+ - You want to check channel status or tail channel logs
6
+ title: "channels"
7
+ ---
8
+
9
+ # `milaidy channels`
10
+
11
+ Manage chat channel accounts and their runtime status on the Gateway.
12
+
13
+ Related docs:
14
+
15
+ - Channel guides: [Channels](/channels/index)
16
+ - Gateway configuration: [Configuration](/gateway/configuration)
17
+
18
+ ## Common commands
19
+
20
+ ```bash
21
+ milaidy channels list
22
+ milaidy channels status
23
+ milaidy channels capabilities
24
+ milaidy channels capabilities --channel discord --target channel:123
25
+ milaidy channels resolve --channel slack "#general" "@jane"
26
+ milaidy channels logs --channel all
27
+ ```
28
+
29
+ ## Add / remove accounts
30
+
31
+ ```bash
32
+ milaidy channels add --channel telegram --token <bot-token>
33
+ milaidy channels remove --channel telegram --delete
34
+ ```
35
+
36
+ Tip: `milaidy channels add --help` shows per-channel flags (token, app token, signal-cli paths, etc).
37
+
38
+ ## Login / logout (interactive)
39
+
40
+ ```bash
41
+ milaidy channels login --channel whatsapp
42
+ milaidy channels logout --channel whatsapp
43
+ ```
44
+
45
+ ## Troubleshooting
46
+
47
+ - Run `milaidy status --deep` for a broad probe.
48
+ - Use `milaidy doctor` for guided fixes.
49
+ - `milaidy channels list` prints `Claude: HTTP 403 ... user:profile` → usage snapshot needs the `user:profile` scope. Use `--no-usage`, or provide a claude.ai session key (`CLAUDE_WEB_SESSION_KEY` / `CLAUDE_WEB_COOKIE`), or re-auth via Claude Code CLI.
50
+
51
+ ## Capabilities probe
52
+
53
+ Fetch provider capability hints (intents/scopes where available) plus static feature support:
54
+
55
+ ```bash
56
+ milaidy channels capabilities
57
+ milaidy channels capabilities --channel discord --target channel:123
58
+ ```
59
+
60
+ Notes:
61
+
62
+ - `--channel` is optional; omit it to list every channel (including extensions).
63
+ - `--target` accepts `channel:<id>` or a raw numeric channel id and only applies to Discord.
64
+ - Probes are provider-specific: Discord intents + optional channel permissions; Slack bot + user scopes; Telegram bot flags + webhook; Signal daemon version; MS Teams app token + Graph roles/scopes (annotated where known). Channels without probes report `Probe: unavailable`.
65
+
66
+ ## Resolve names to IDs
67
+
68
+ Resolve channel/user names to IDs using the provider directory:
69
+
70
+ ```bash
71
+ milaidy channels resolve --channel slack "#general" "@jane"
72
+ milaidy channels resolve --channel discord "My Server/#support" "@someone"
73
+ milaidy channels resolve --channel matrix "Project Room"
74
+ ```
75
+
76
+ Notes:
77
+
78
+ - Use `--kind user|group|auto` to force the target type.
79
+ - Resolution prefers active matches when multiple entries share the same name.
@@ -0,0 +1,50 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy config` (get/set/unset config values)"
3
+ read_when:
4
+ - You want to read or edit config non-interactively
5
+ title: "config"
6
+ ---
7
+
8
+ # `milaidy config`
9
+
10
+ Config helpers: get/set/unset values by path. Run without a subcommand to open
11
+ the configure wizard (same as `milaidy configure`).
12
+
13
+ ## Examples
14
+
15
+ ```bash
16
+ milaidy config get browser.executablePath
17
+ milaidy config set browser.executablePath "/usr/bin/google-chrome"
18
+ milaidy config set agents.defaults.heartbeat.every "2h"
19
+ milaidy config set agents.list[0].tools.exec.node "node-id-or-name"
20
+ milaidy config unset tools.web.search.apiKey
21
+ ```
22
+
23
+ ## Paths
24
+
25
+ Paths use dot or bracket notation:
26
+
27
+ ```bash
28
+ milaidy config get agents.defaults.workspace
29
+ milaidy config get agents.list[0].id
30
+ ```
31
+
32
+ Use the agent list index to target a specific agent:
33
+
34
+ ```bash
35
+ milaidy config get agents.list
36
+ milaidy config set agents.list[1].tools.exec.node "node-id-or-name"
37
+ ```
38
+
39
+ ## Values
40
+
41
+ Values are parsed as JSON5 when possible; otherwise they are treated as strings.
42
+ Use `--json` to require JSON5 parsing.
43
+
44
+ ```bash
45
+ milaidy config set agents.defaults.heartbeat.every "0m"
46
+ milaidy config set gateway.port 19001 --json
47
+ milaidy config set channels.whatsapp.groups '["*"]' --json
48
+ ```
49
+
50
+ Restart the gateway after edits.
@@ -0,0 +1,33 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy configure` (interactive configuration prompts)"
3
+ read_when:
4
+ - You want to tweak credentials, devices, or agent defaults interactively
5
+ title: "configure"
6
+ ---
7
+
8
+ # `milaidy configure`
9
+
10
+ Interactive prompt to set up credentials, devices, and agent defaults.
11
+
12
+ Note: The **Model** section now includes a multi-select for the
13
+ `agents.defaults.models` allowlist (what shows up in `/model` and the model picker).
14
+
15
+ Tip: `milaidy config` without a subcommand opens the same wizard. Use
16
+ `milaidy config get|set|unset` for non-interactive edits.
17
+
18
+ Related:
19
+
20
+ - Gateway configuration reference: [Configuration](/gateway/configuration)
21
+ - Config CLI: [Config](/cli/config)
22
+
23
+ Notes:
24
+
25
+ - Choosing where the Gateway runs always updates `gateway.mode`. You can select "Continue" without other sections if that is all you need.
26
+ - Channel-oriented services (Slack/Discord/Matrix/Microsoft Teams) prompt for channel/room allowlists during setup. You can enter names or IDs; the wizard resolves names to IDs when possible.
27
+
28
+ ## Examples
29
+
30
+ ```bash
31
+ milaidy configure
32
+ milaidy configure --section models --section channels
33
+ ```
@@ -0,0 +1,42 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy cron` (schedule and run background jobs)"
3
+ read_when:
4
+ - You want scheduled jobs and wakeups
5
+ - You’re debugging cron execution and logs
6
+ title: "cron"
7
+ ---
8
+
9
+ # `milaidy cron`
10
+
11
+ Manage cron jobs for the Gateway scheduler.
12
+
13
+ Related:
14
+
15
+ - Cron jobs: [Cron jobs](/automation/cron-jobs)
16
+
17
+ Tip: run `milaidy cron --help` for the full command surface.
18
+
19
+ Note: isolated `cron add` jobs default to `--announce` delivery. Use `--no-deliver` to keep
20
+ output internal. `--deliver` remains as a deprecated alias for `--announce`.
21
+
22
+ Note: one-shot (`--at`) jobs delete after success by default. Use `--keep-after-run` to keep them.
23
+
24
+ ## Common edits
25
+
26
+ Update delivery settings without changing the message:
27
+
28
+ ```bash
29
+ milaidy cron edit <job-id> --announce --channel telegram --to "123456789"
30
+ ```
31
+
32
+ Disable delivery for an isolated job:
33
+
34
+ ```bash
35
+ milaidy cron edit <job-id> --no-deliver
36
+ ```
37
+
38
+ Announce to a specific channel:
39
+
40
+ ```bash
41
+ milaidy cron edit <job-id> --announce --channel slack --to "channel:C1234567890"
42
+ ```
@@ -0,0 +1,16 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy dashboard` (open the Control UI)"
3
+ read_when:
4
+ - You want to open the Control UI with your current token
5
+ - You want to print the URL without launching a browser
6
+ title: "dashboard"
7
+ ---
8
+
9
+ # `milaidy dashboard`
10
+
11
+ Open the Control UI using your current auth.
12
+
13
+ ```bash
14
+ milaidy dashboard
15
+ milaidy dashboard --no-open
16
+ ```
@@ -0,0 +1,67 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy devices` (device pairing + token rotation/revocation)"
3
+ read_when:
4
+ - You are approving device pairing requests
5
+ - You need to rotate or revoke device tokens
6
+ title: "devices"
7
+ ---
8
+
9
+ # `milaidy devices`
10
+
11
+ Manage device pairing requests and device-scoped tokens.
12
+
13
+ ## Commands
14
+
15
+ ### `milaidy devices list`
16
+
17
+ List pending pairing requests and paired devices.
18
+
19
+ ```
20
+ milaidy devices list
21
+ milaidy devices list --json
22
+ ```
23
+
24
+ ### `milaidy devices approve <requestId>`
25
+
26
+ Approve a pending device pairing request.
27
+
28
+ ```
29
+ milaidy devices approve <requestId>
30
+ ```
31
+
32
+ ### `milaidy devices reject <requestId>`
33
+
34
+ Reject a pending device pairing request.
35
+
36
+ ```
37
+ milaidy devices reject <requestId>
38
+ ```
39
+
40
+ ### `milaidy devices rotate --device <id> --role <role> [--scope <scope...>]`
41
+
42
+ Rotate a device token for a specific role (optionally updating scopes).
43
+
44
+ ```
45
+ milaidy devices rotate --device <deviceId> --role operator --scope operator.read --scope operator.write
46
+ ```
47
+
48
+ ### `milaidy devices revoke --device <id> --role <role>`
49
+
50
+ Revoke a device token for a specific role.
51
+
52
+ ```
53
+ milaidy devices revoke --device <deviceId> --role node
54
+ ```
55
+
56
+ ## Common options
57
+
58
+ - `--url <url>`: Gateway WebSocket URL (defaults to `gateway.remote.url` when configured).
59
+ - `--token <token>`: Gateway token (if required).
60
+ - `--password <password>`: Gateway password (password auth).
61
+ - `--timeout <ms>`: RPC timeout.
62
+ - `--json`: JSON output (recommended for scripting).
63
+
64
+ ## Notes
65
+
66
+ - Token rotation returns a new token (sensitive). Treat it like a secret.
67
+ - These commands require `operator.pairing` (or `operator.admin`) scope.
@@ -0,0 +1,63 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy directory` (self, peers, groups)"
3
+ read_when:
4
+ - You want to look up contacts/groups/self ids for a channel
5
+ - You are developing a channel directory adapter
6
+ title: "directory"
7
+ ---
8
+
9
+ # `milaidy directory`
10
+
11
+ Directory lookups for channels that support it (contacts/peers, groups, and “me”).
12
+
13
+ ## Common flags
14
+
15
+ - `--channel <name>`: channel id/alias (required when multiple channels are configured; auto when only one is configured)
16
+ - `--account <id>`: account id (default: channel default)
17
+ - `--json`: output JSON
18
+
19
+ ## Notes
20
+
21
+ - `directory` is meant to help you find IDs you can paste into other commands (especially `milaidy message send --target ...`).
22
+ - For many channels, results are config-backed (allowlists / configured groups) rather than a live provider directory.
23
+ - Default output is `id` (and sometimes `name`) separated by a tab; use `--json` for scripting.
24
+
25
+ ## Using results with `message send`
26
+
27
+ ```bash
28
+ milaidy directory peers list --channel slack --query "U0"
29
+ milaidy message send --channel slack --target user:U012ABCDEF --message "hello"
30
+ ```
31
+
32
+ ## ID formats (by channel)
33
+
34
+ - WhatsApp: `+15551234567` (DM), `1234567890-1234567890@g.us` (group)
35
+ - Telegram: `@username` or numeric chat id; groups are numeric ids
36
+ - Slack: `user:U…` and `channel:C…`
37
+ - Discord: `user:<id>` and `channel:<id>`
38
+ - Matrix (plugin): `user:@user:server`, `room:!roomId:server`, or `#alias:server`
39
+ - Microsoft Teams (plugin): `user:<id>` and `conversation:<id>`
40
+ - Zalo (plugin): user id (Bot API)
41
+ - Zalo Personal / `zalouser` (plugin): thread id (DM/group) from `zca` (`me`, `friend list`, `group list`)
42
+
43
+ ## Self (“me”)
44
+
45
+ ```bash
46
+ milaidy directory self --channel zalouser
47
+ ```
48
+
49
+ ## Peers (contacts/users)
50
+
51
+ ```bash
52
+ milaidy directory peers list --channel zalouser
53
+ milaidy directory peers list --channel zalouser --query "name"
54
+ milaidy directory peers list --channel zalouser --limit 50
55
+ ```
56
+
57
+ ## Groups
58
+
59
+ ```bash
60
+ milaidy directory groups list --channel zalouser
61
+ milaidy directory groups list --channel zalouser --query "work"
62
+ milaidy directory groups members --channel zalouser --group-id <id>
63
+ ```
@@ -0,0 +1,23 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy dns` (wide-area discovery helpers)"
3
+ read_when:
4
+ - You want wide-area discovery (DNS-SD) via Tailscale + CoreDNS
5
+ - You’re setting up split DNS for a custom discovery domain (example: milaidy.internal)
6
+ title: "dns"
7
+ ---
8
+
9
+ # `milaidy dns`
10
+
11
+ DNS helpers for wide-area discovery (Tailscale + CoreDNS). Currently focused on macOS + Homebrew CoreDNS.
12
+
13
+ Related:
14
+
15
+ - Gateway discovery: [Discovery](/gateway/discovery)
16
+ - Wide-area discovery config: [Configuration](/gateway/configuration)
17
+
18
+ ## Setup
19
+
20
+ ```bash
21
+ milaidy dns setup
22
+ milaidy dns setup --apply
23
+ ```
@@ -0,0 +1,15 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy docs` (search the live docs index)"
3
+ read_when:
4
+ - You want to search the live Milaidy docs from the terminal
5
+ title: "docs"
6
+ ---
7
+
8
+ # `milaidy docs`
9
+
10
+ Search the live docs index.
11
+
12
+ ```bash
13
+ milaidy docs browser extension
14
+ milaidy docs sandbox allowHostControl
15
+ ```
@@ -0,0 +1,41 @@
1
+ ---
2
+ summary: "CLI reference for `milaidy doctor` (health checks + guided repairs)"
3
+ read_when:
4
+ - You have connectivity/auth issues and want guided fixes
5
+ - You updated and want a sanity check
6
+ title: "doctor"
7
+ ---
8
+
9
+ # `milaidy doctor`
10
+
11
+ Health checks + quick fixes for the gateway and channels.
12
+
13
+ Related:
14
+
15
+ - Troubleshooting: [Troubleshooting](/gateway/troubleshooting)
16
+ - Security audit: [Security](/gateway/security)
17
+
18
+ ## Examples
19
+
20
+ ```bash
21
+ milaidy doctor
22
+ milaidy doctor --repair
23
+ milaidy doctor --deep
24
+ ```
25
+
26
+ Notes:
27
+
28
+ - Interactive prompts (like keychain/OAuth fixes) only run when stdin is a TTY and `--non-interactive` is **not** set. Headless runs (cron, Telegram, no terminal) will skip prompts.
29
+ - `--fix` (alias for `--repair`) writes a backup to `~/.milaidy/milaidy.json.bak` and drops unknown config keys, listing each removal.
30
+
31
+ ## macOS: `launchctl` env overrides
32
+
33
+ If you previously ran `launchctl setenv MILAIDY_GATEWAY_TOKEN ...` (or `...PASSWORD`), that value overrides your config file and can cause persistent “unauthorized” errors.
34
+
35
+ ```bash
36
+ launchctl getenv MILAIDY_GATEWAY_TOKEN
37
+ launchctl getenv MILAIDY_GATEWAY_PASSWORD
38
+
39
+ launchctl unsetenv MILAIDY_GATEWAY_TOKEN
40
+ launchctl unsetenv MILAIDY_GATEWAY_PASSWORD
41
+ ```