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.
- package/LICENSE +8 -0
- package/README.md +538 -0
- package/dist/argv-CfSowvEA.js +63 -0
- package/dist/config-B-mboG4v.js +4 -0
- package/dist/eliza-CPJjgw-e.js +1491 -0
- package/dist/eliza.js +2192 -0
- package/dist/entry.js +232 -0
- package/dist/index.js +209 -0
- package/dist/links-BFKlWqSe.js +15 -0
- package/dist/paths-D_yh1DEJ.js +69 -0
- package/dist/plugins-cli-B7kSre2c.js +134 -0
- package/dist/program-6KwWwKKh.js +510 -0
- package/dist/register.agents-CPVmSjMG.js +17 -0
- package/dist/register.browser-B2ooXxNx.js +15 -0
- package/dist/register.channels-CMYQ6K6Y.js +42 -0
- package/dist/register.cron-D91lY1_Y.js +9 -0
- package/dist/register.devices-rU5I5L_y.js +13 -0
- package/dist/register.gateway-82SLAvw3.js +22 -0
- package/dist/register.hooks-B_XTBEkt.js +9 -0
- package/dist/register.logs-BgEGcPd8.js +10 -0
- package/dist/register.models-BJt9eVgZ.js +26 -0
- package/dist/register.nodes-B5xY1s8a.js +9 -0
- package/dist/register.skills-SFQqYIhg.js +10 -0
- package/dist/register.subclis-uF_AsbWR.js +187 -0
- package/dist/run-main-XODklzS-.js +56 -0
- package/dist/theme-DBvtuGeq.js +36 -0
- package/dist/utils-C1AUpp_V.js +42 -0
- package/dist/version-Cpn3yr5D.js +26 -0
- package/dist/workspace-Co3Wul2D.js +206 -0
- package/dist/workspace-DCA6MNVK.js +350 -0
- package/docs/.i18n/README.md +31 -0
- package/docs/.i18n/glossary.zh-CN.json +210 -0
- package/docs/.i18n/zh-CN.tm.jsonl +1329 -0
- package/docs/CNAME +1 -0
- package/docs/automation/cron-jobs.md +468 -0
- package/docs/automation/cron-vs-heartbeat.md +254 -0
- package/docs/automation/gmail-pubsub.md +256 -0
- package/docs/automation/poll.md +69 -0
- package/docs/automation/webhook.md +163 -0
- package/docs/bedrock.md +176 -0
- package/docs/brave-search.md +41 -0
- package/docs/broadcast-groups.md +442 -0
- package/docs/cli/acp.md +170 -0
- package/docs/cli/agent.md +24 -0
- package/docs/cli/agents.md +75 -0
- package/docs/cli/approvals.md +50 -0
- package/docs/cli/browser.md +107 -0
- package/docs/cli/channels.md +79 -0
- package/docs/cli/config.md +50 -0
- package/docs/cli/configure.md +33 -0
- package/docs/cli/cron.md +42 -0
- package/docs/cli/dashboard.md +16 -0
- package/docs/cli/devices.md +67 -0
- package/docs/cli/directory.md +63 -0
- package/docs/cli/dns.md +23 -0
- package/docs/cli/docs.md +15 -0
- package/docs/cli/doctor.md +41 -0
- package/docs/cli/gateway.md +199 -0
- package/docs/cli/health.md +21 -0
- package/docs/cli/hooks.md +291 -0
- package/docs/cli/index.md +1029 -0
- package/docs/cli/logs.md +24 -0
- package/docs/cli/memory.md +45 -0
- package/docs/cli/message.md +239 -0
- package/docs/cli/models.md +79 -0
- package/docs/cli/node.md +112 -0
- package/docs/cli/nodes.md +73 -0
- package/docs/cli/onboard.md +29 -0
- package/docs/cli/pairing.md +21 -0
- package/docs/cli/plugins.md +62 -0
- package/docs/cli/reset.md +17 -0
- package/docs/cli/sandbox.md +152 -0
- package/docs/cli/security.md +26 -0
- package/docs/cli/sessions.md +16 -0
- package/docs/cli/setup.md +29 -0
- package/docs/cli/skills.md +26 -0
- package/docs/cli/status.md +26 -0
- package/docs/cli/system.md +60 -0
- package/docs/cli/tui.md +23 -0
- package/docs/cli/uninstall.md +17 -0
- package/docs/cli/update.md +98 -0
- package/docs/cli/voicecall.md +34 -0
- package/docs/cli/webhooks.md +25 -0
- package/docs/concepts/agent-loop.md +146 -0
- package/docs/concepts/agent-workspace.md +229 -0
- package/docs/concepts/agent.md +122 -0
- package/docs/concepts/architecture.md +129 -0
- package/docs/concepts/channel-routing.md +114 -0
- package/docs/concepts/compaction.md +61 -0
- package/docs/concepts/context.md +159 -0
- package/docs/concepts/features.md +53 -0
- package/docs/concepts/group-messages.md +84 -0
- package/docs/concepts/groups.md +373 -0
- package/docs/concepts/markdown-formatting.md +130 -0
- package/docs/concepts/memory.md +546 -0
- package/docs/concepts/messages.md +154 -0
- package/docs/concepts/model-failover.md +149 -0
- package/docs/concepts/model-providers.md +315 -0
- package/docs/concepts/models.md +208 -0
- package/docs/concepts/multi-agent.md +376 -0
- package/docs/concepts/oauth.md +145 -0
- package/docs/concepts/plugins.md +454 -0
- package/docs/concepts/presence.md +102 -0
- package/docs/concepts/queue.md +89 -0
- package/docs/concepts/retry.md +69 -0
- package/docs/concepts/secrets.md +300 -0
- package/docs/concepts/session-pruning.md +122 -0
- package/docs/concepts/session-tool.md +193 -0
- package/docs/concepts/session.md +188 -0
- package/docs/concepts/sessions.md +10 -0
- package/docs/concepts/skills.md +392 -0
- package/docs/concepts/streaming.md +135 -0
- package/docs/concepts/system-prompt.md +114 -0
- package/docs/concepts/timezone.md +91 -0
- package/docs/concepts/typebox.md +289 -0
- package/docs/concepts/typing-indicators.md +68 -0
- package/docs/concepts/usage-tracking.md +35 -0
- package/docs/custom.css +4 -0
- package/docs/date-time.md +128 -0
- package/docs/debugging.md +162 -0
- package/docs/docs.json +1599 -0
- package/docs/environment.md +81 -0
- package/docs/hooks.md +876 -0
- package/docs/index.md +179 -0
- package/docs/install/ansible.md +208 -0
- package/docs/install/bun.md +59 -0
- package/docs/install/development-channels.md +75 -0
- package/docs/install/docker.md +567 -0
- package/docs/install/index.md +185 -0
- package/docs/install/installer.md +123 -0
- package/docs/install/migrating.md +192 -0
- package/docs/install/nix.md +96 -0
- package/docs/install/node.md +78 -0
- package/docs/install/uninstall.md +128 -0
- package/docs/install/updating.md +228 -0
- package/docs/logging.md +350 -0
- package/docs/multi-agent-sandbox-tools.md +395 -0
- package/docs/network.md +54 -0
- package/docs/nodes/audio.md +114 -0
- package/docs/nodes/camera.md +156 -0
- package/docs/nodes/images.md +72 -0
- package/docs/nodes/index.md +341 -0
- package/docs/nodes/location-command.md +113 -0
- package/docs/nodes/media-understanding.md +379 -0
- package/docs/nodes/talk.md +90 -0
- package/docs/nodes/voicewake.md +65 -0
- package/docs/northflank.mdx +53 -0
- package/docs/perplexity.md +80 -0
- package/docs/platforms/android.md +129 -0
- package/docs/platforms/digitalocean.md +262 -0
- package/docs/platforms/exe-dev.md +125 -0
- package/docs/platforms/fly.md +486 -0
- package/docs/platforms/gcp.md +503 -0
- package/docs/platforms/hetzner.md +330 -0
- package/docs/platforms/index.md +53 -0
- package/docs/platforms/ios.md +106 -0
- package/docs/platforms/linux.md +94 -0
- package/docs/platforms/mac/bundled-gateway.md +73 -0
- package/docs/platforms/mac/canvas.md +125 -0
- package/docs/platforms/mac/child-process.md +69 -0
- package/docs/platforms/mac/dev-setup.md +102 -0
- package/docs/platforms/mac/health.md +34 -0
- package/docs/platforms/mac/icon.md +31 -0
- package/docs/platforms/mac/logging.md +57 -0
- package/docs/platforms/mac/menu-bar.md +81 -0
- package/docs/platforms/mac/peekaboo.md +65 -0
- package/docs/platforms/mac/permissions.md +44 -0
- package/docs/platforms/mac/release.md +85 -0
- package/docs/platforms/mac/remote.md +83 -0
- package/docs/platforms/mac/signing.md +47 -0
- package/docs/platforms/mac/skills.md +33 -0
- package/docs/platforms/mac/voice-overlay.md +60 -0
- package/docs/platforms/mac/voicewake.md +67 -0
- package/docs/platforms/mac/webchat.md +41 -0
- package/docs/platforms/mac/xpc.md +61 -0
- package/docs/platforms/macos-vm.md +281 -0
- package/docs/platforms/macos.md +203 -0
- package/docs/platforms/oracle.md +303 -0
- package/docs/platforms/raspberry-pi.md +358 -0
- package/docs/platforms/windows.md +159 -0
- package/docs/plugin.md +651 -0
- package/docs/plugins/agent-tools.md +99 -0
- package/docs/plugins/manifest.md +71 -0
- package/docs/plugins/voice-call.md +273 -0
- package/docs/plugins/zalouser.md +70 -0
- package/docs/providers/anthropic.md +152 -0
- package/docs/providers/claude-max-api-proxy.md +148 -0
- package/docs/providers/cloudflare-ai-gateway.md +71 -0
- package/docs/providers/deepgram.md +93 -0
- package/docs/providers/glm.md +33 -0
- package/docs/providers/index.md +63 -0
- package/docs/providers/minimax.md +208 -0
- package/docs/providers/models.md +51 -0
- package/docs/providers/moonshot.md +142 -0
- package/docs/providers/ollama.md +223 -0
- package/docs/providers/openai.md +62 -0
- package/docs/providers/opencode.md +36 -0
- package/docs/providers/openrouter.md +37 -0
- package/docs/providers/qwen.md +53 -0
- package/docs/providers/synthetic.md +99 -0
- package/docs/providers/venice.md +267 -0
- package/docs/providers/vercel-ai-gateway.md +50 -0
- package/docs/providers/xiaomi.md +64 -0
- package/docs/providers/zai.md +36 -0
- package/docs/railway.mdx +99 -0
- package/docs/reference/templates/AGENTS.md +9 -0
- package/docs/reference/templates/BOOTSTRAP.md +3 -0
- package/docs/reference/templates/HEARTBEAT.md +3 -0
- package/docs/reference/templates/IDENTITY.md +3 -0
- package/docs/reference/templates/TOOLS.md +3 -0
- package/docs/reference/templates/USER.md +3 -0
- package/docs/render.mdx +165 -0
- package/docs/start/docs-directory.md +63 -0
- package/docs/start/getting-started.md +212 -0
- package/docs/start/milaidy.md +247 -0
- package/docs/start/onboarding.md +258 -0
- package/docs/start/pairing.md +86 -0
- package/docs/start/quickstart.md +81 -0
- package/docs/start/setup.md +149 -0
- package/docs/start/showcase.md +416 -0
- package/docs/start/wizard.md +418 -0
- package/docs/testing.md +368 -0
- package/docs/token-use.md +112 -0
- package/docs/tools/agent-send.md +53 -0
- package/docs/tools/apply-patch.md +50 -0
- package/docs/tools/browser-linux-troubleshooting.md +139 -0
- package/docs/tools/browser-login.md +68 -0
- package/docs/tools/browser.md +576 -0
- package/docs/tools/chrome-extension.md +178 -0
- package/docs/tools/clawhub.md +257 -0
- package/docs/tools/creating-skills.md +54 -0
- package/docs/tools/elevated.md +57 -0
- package/docs/tools/exec-approvals.md +246 -0
- package/docs/tools/exec.md +179 -0
- package/docs/tools/firecrawl.md +61 -0
- package/docs/tools/index.md +508 -0
- package/docs/tools/llm-task.md +115 -0
- package/docs/tools/reactions.md +22 -0
- package/docs/tools/skills-config.md +76 -0
- package/docs/tools/skills.md +300 -0
- package/docs/tools/slash-commands.md +196 -0
- package/docs/tools/subagents.md +151 -0
- package/docs/tools/thinking.md +73 -0
- package/docs/tools/web.md +261 -0
- package/docs/tui.md +159 -0
- package/docs/vps.md +43 -0
- package/docs/web/control-ui.md +221 -0
- package/docs/web/dashboard.md +46 -0
- package/docs/web/index.md +116 -0
- package/docs/web/webchat.md +49 -0
- package/milaidy.mjs +14 -0
- package/package.json +271 -0
- package/skills/.cache/catalog.json +88519 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy reset` (reset local state/config)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to wipe local state while keeping the CLI installed
|
|
5
|
+
- You want a dry-run of what would be removed
|
|
6
|
+
title: "reset"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy reset`
|
|
10
|
+
|
|
11
|
+
Reset local config/state (keeps the CLI installed).
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
milaidy reset
|
|
15
|
+
milaidy reset --dry-run
|
|
16
|
+
milaidy reset --scope config+creds+sessions --yes --non-interactive
|
|
17
|
+
```
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Sandbox CLI
|
|
3
|
+
summary: "Manage sandbox containers and inspect effective sandbox policy"
|
|
4
|
+
read_when: "You are managing sandbox containers or debugging sandbox/tool-policy behavior."
|
|
5
|
+
status: active
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Sandbox CLI
|
|
9
|
+
|
|
10
|
+
Manage Docker-based sandbox containers for isolated agent execution.
|
|
11
|
+
|
|
12
|
+
## Overview
|
|
13
|
+
|
|
14
|
+
Milaidy can run agents in isolated Docker containers for security. The `sandbox` commands help you manage these containers, especially after updates or configuration changes.
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
### `milaidy sandbox explain`
|
|
19
|
+
|
|
20
|
+
Inspect the **effective** sandbox mode/scope/workspace access, sandbox tool policy, and elevated gates (with fix-it config key paths).
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
milaidy sandbox explain
|
|
24
|
+
milaidy sandbox explain --session agent:main:main
|
|
25
|
+
milaidy sandbox explain --agent work
|
|
26
|
+
milaidy sandbox explain --json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### `milaidy sandbox list`
|
|
30
|
+
|
|
31
|
+
List all sandbox containers with their status and configuration.
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
milaidy sandbox list
|
|
35
|
+
milaidy sandbox list --browser # List only browser containers
|
|
36
|
+
milaidy sandbox list --json # JSON output
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Output includes:**
|
|
40
|
+
|
|
41
|
+
- Container name and status (running/stopped)
|
|
42
|
+
- Docker image and whether it matches config
|
|
43
|
+
- Age (time since creation)
|
|
44
|
+
- Idle time (time since last use)
|
|
45
|
+
- Associated session/agent
|
|
46
|
+
|
|
47
|
+
### `milaidy sandbox recreate`
|
|
48
|
+
|
|
49
|
+
Remove sandbox containers to force recreation with updated images/config.
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
milaidy sandbox recreate --all # Recreate all containers
|
|
53
|
+
milaidy sandbox recreate --session main # Specific session
|
|
54
|
+
milaidy sandbox recreate --agent mybot # Specific agent
|
|
55
|
+
milaidy sandbox recreate --browser # Only browser containers
|
|
56
|
+
milaidy sandbox recreate --all --force # Skip confirmation
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**Options:**
|
|
60
|
+
|
|
61
|
+
- `--all`: Recreate all sandbox containers
|
|
62
|
+
- `--session <key>`: Recreate container for specific session
|
|
63
|
+
- `--agent <id>`: Recreate containers for specific agent
|
|
64
|
+
- `--browser`: Only recreate browser containers
|
|
65
|
+
- `--force`: Skip confirmation prompt
|
|
66
|
+
|
|
67
|
+
**Important:** Containers are automatically recreated when the agent is next used.
|
|
68
|
+
|
|
69
|
+
## Use Cases
|
|
70
|
+
|
|
71
|
+
### After updating Docker images
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
# Pull new image
|
|
75
|
+
docker pull milaidy-sandbox:latest
|
|
76
|
+
docker tag milaidy-sandbox:latest milaidy-sandbox:bookworm-slim
|
|
77
|
+
|
|
78
|
+
# Update config to use new image
|
|
79
|
+
# Edit config: agents.defaults.sandbox.docker.image (or agents.list[].sandbox.docker.image)
|
|
80
|
+
|
|
81
|
+
# Recreate containers
|
|
82
|
+
milaidy sandbox recreate --all
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### After changing sandbox configuration
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
# Edit config: agents.defaults.sandbox.* (or agents.list[].sandbox.*)
|
|
89
|
+
|
|
90
|
+
# Recreate to apply new config
|
|
91
|
+
milaidy sandbox recreate --all
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### After changing setupCommand
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
milaidy sandbox recreate --all
|
|
98
|
+
# or just one agent:
|
|
99
|
+
milaidy sandbox recreate --agent family
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### For a specific agent only
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
# Update only one agent's containers
|
|
106
|
+
milaidy sandbox recreate --agent alfred
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## Why is this needed?
|
|
110
|
+
|
|
111
|
+
**Problem:** When you update sandbox Docker images or configuration:
|
|
112
|
+
|
|
113
|
+
- Existing containers continue running with old settings
|
|
114
|
+
- Containers are only pruned after 24h of inactivity
|
|
115
|
+
- Regularly-used agents keep old containers running indefinitely
|
|
116
|
+
|
|
117
|
+
**Solution:** Use `milaidy sandbox recreate` to force removal of old containers. They'll be recreated automatically with current settings when next needed.
|
|
118
|
+
|
|
119
|
+
Tip: prefer `milaidy sandbox recreate` over manual `docker rm`. It uses the
|
|
120
|
+
Gateway’s container naming and avoids mismatches when scope/session keys change.
|
|
121
|
+
|
|
122
|
+
## Configuration
|
|
123
|
+
|
|
124
|
+
Sandbox settings live in `~/.milaidy/milaidy.json` under `agents.defaults.sandbox` (per-agent overrides go in `agents.list[].sandbox`):
|
|
125
|
+
|
|
126
|
+
```jsonc
|
|
127
|
+
{
|
|
128
|
+
"agents": {
|
|
129
|
+
"defaults": {
|
|
130
|
+
"sandbox": {
|
|
131
|
+
"mode": "all", // off, non-main, all
|
|
132
|
+
"scope": "agent", // session, agent, shared
|
|
133
|
+
"docker": {
|
|
134
|
+
"image": "milaidy-sandbox:bookworm-slim",
|
|
135
|
+
"containerPrefix": "milaidy-sbx-",
|
|
136
|
+
// ... more Docker options
|
|
137
|
+
},
|
|
138
|
+
"prune": {
|
|
139
|
+
"idleHours": 24, // Auto-prune after 24h idle
|
|
140
|
+
"maxAgeDays": 7, // Auto-prune after 7 days
|
|
141
|
+
},
|
|
142
|
+
},
|
|
143
|
+
},
|
|
144
|
+
},
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## See Also
|
|
149
|
+
|
|
150
|
+
- [Sandbox Documentation](/gateway/sandboxing)
|
|
151
|
+
- [Agent Configuration](/concepts/agent-workspace)
|
|
152
|
+
- [Doctor Command](/gateway/doctor) - Check sandbox setup
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy security` (audit and fix common security footguns)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to run a quick security audit on config/state
|
|
5
|
+
- You want to apply safe “fix” suggestions (chmod, tighten defaults)
|
|
6
|
+
title: "security"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy security`
|
|
10
|
+
|
|
11
|
+
Security tools (audit + optional fixes).
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Security guide: [Security](/gateway/security)
|
|
16
|
+
|
|
17
|
+
## Audit
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
milaidy security audit
|
|
21
|
+
milaidy security audit --deep
|
|
22
|
+
milaidy security audit --fix
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The audit warns when multiple DM senders share the main session and recommends **secure DM mode**: `session.dmScope="per-channel-peer"` (or `per-account-channel-peer` for multi-account channels) for shared inboxes.
|
|
26
|
+
It also warns when small models (`<=300B`) are used without sandboxing and with web/browser tools enabled.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy sessions` (list stored sessions + usage)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to list stored sessions and see recent activity
|
|
5
|
+
title: "sessions"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# `milaidy sessions`
|
|
9
|
+
|
|
10
|
+
List stored conversation sessions.
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
milaidy sessions
|
|
14
|
+
milaidy sessions --active 120
|
|
15
|
+
milaidy sessions --json
|
|
16
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy setup` (initialize config + workspace)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You’re doing first-run setup without the full onboarding wizard
|
|
5
|
+
- You want to set the default workspace path
|
|
6
|
+
title: "setup"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy setup`
|
|
10
|
+
|
|
11
|
+
Initialize `~/.milaidy/milaidy.json` and the agent workspace.
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Getting started: [Getting started](/start/getting-started)
|
|
16
|
+
- Wizard: [Onboarding](/start/onboarding)
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
milaidy setup
|
|
22
|
+
milaidy setup --workspace ~/.milaidy/workspace
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
To run the wizard via setup:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
milaidy setup --wizard
|
|
29
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy skills` (list/info/check) and skill eligibility"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to see which skills are available and ready to run
|
|
5
|
+
- You want to debug missing binaries/env/config for skills
|
|
6
|
+
title: "skills"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy skills`
|
|
10
|
+
|
|
11
|
+
Inspect skills (bundled + workspace + managed overrides) and see what’s eligible vs missing requirements.
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Skills system: [Skills](/tools/skills)
|
|
16
|
+
- Skills config: [Skills config](/tools/skills-config)
|
|
17
|
+
- ClawHub installs: [ClawHub](/tools/clawhub)
|
|
18
|
+
|
|
19
|
+
## Commands
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
milaidy skills list
|
|
23
|
+
milaidy skills list --eligible
|
|
24
|
+
milaidy skills info <name>
|
|
25
|
+
milaidy skills check
|
|
26
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy status` (diagnostics, probes, usage snapshots)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want a quick diagnosis of channel health + recent session recipients
|
|
5
|
+
- You want a pasteable “all” status for debugging
|
|
6
|
+
title: "status"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy status`
|
|
10
|
+
|
|
11
|
+
Diagnostics for channels + sessions.
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
milaidy status
|
|
15
|
+
milaidy status --all
|
|
16
|
+
milaidy status --deep
|
|
17
|
+
milaidy status --usage
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Notes:
|
|
21
|
+
|
|
22
|
+
- `--deep` runs live probes (WhatsApp Web + Telegram + Discord + Google Chat + Slack + Signal).
|
|
23
|
+
- Output includes per-agent session stores when multiple agents are configured.
|
|
24
|
+
- Overview includes Gateway + node host service install/runtime status when available.
|
|
25
|
+
- Overview includes update channel + git SHA (for source checkouts).
|
|
26
|
+
- Update info surfaces in the Overview; if an update is available, status prints a hint to run `milaidy update` (see [Updating](/install/updating)).
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy system` (system events, heartbeat, presence)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to enqueue a system event without creating a cron job
|
|
5
|
+
- You need to enable or disable heartbeats
|
|
6
|
+
- You want to inspect system presence entries
|
|
7
|
+
title: "system"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# `milaidy system`
|
|
11
|
+
|
|
12
|
+
System-level helpers for the Gateway: enqueue system events, control heartbeats,
|
|
13
|
+
and view presence.
|
|
14
|
+
|
|
15
|
+
## Common commands
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
milaidy system event --text "Check for urgent follow-ups" --mode now
|
|
19
|
+
milaidy system heartbeat enable
|
|
20
|
+
milaidy system heartbeat last
|
|
21
|
+
milaidy system presence
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## `system event`
|
|
25
|
+
|
|
26
|
+
Enqueue a system event on the **main** session. The next heartbeat will inject
|
|
27
|
+
it as a `System:` line in the prompt. Use `--mode now` to trigger the heartbeat
|
|
28
|
+
immediately; `next-heartbeat` waits for the next scheduled tick.
|
|
29
|
+
|
|
30
|
+
Flags:
|
|
31
|
+
|
|
32
|
+
- `--text <text>`: required system event text.
|
|
33
|
+
- `--mode <mode>`: `now` or `next-heartbeat` (default).
|
|
34
|
+
- `--json`: machine-readable output.
|
|
35
|
+
|
|
36
|
+
## `system heartbeat last|enable|disable`
|
|
37
|
+
|
|
38
|
+
Heartbeat controls:
|
|
39
|
+
|
|
40
|
+
- `last`: show the last heartbeat event.
|
|
41
|
+
- `enable`: turn heartbeats back on (use this if they were disabled).
|
|
42
|
+
- `disable`: pause heartbeats.
|
|
43
|
+
|
|
44
|
+
Flags:
|
|
45
|
+
|
|
46
|
+
- `--json`: machine-readable output.
|
|
47
|
+
|
|
48
|
+
## `system presence`
|
|
49
|
+
|
|
50
|
+
List the current system presence entries the Gateway knows about (nodes,
|
|
51
|
+
instances, and similar status lines).
|
|
52
|
+
|
|
53
|
+
Flags:
|
|
54
|
+
|
|
55
|
+
- `--json`: machine-readable output.
|
|
56
|
+
|
|
57
|
+
## Notes
|
|
58
|
+
|
|
59
|
+
- Requires a running Gateway reachable by your current config (local or remote).
|
|
60
|
+
- System events are ephemeral and not persisted across restarts.
|
package/docs/cli/tui.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy tui` (terminal UI connected to the Gateway)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want a terminal UI for the Gateway (remote-friendly)
|
|
5
|
+
- You want to pass url/token/session from scripts
|
|
6
|
+
title: "tui"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy tui`
|
|
10
|
+
|
|
11
|
+
Open the terminal UI connected to the Gateway.
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- TUI guide: [TUI](/tui)
|
|
16
|
+
|
|
17
|
+
## Examples
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
milaidy tui
|
|
21
|
+
milaidy tui --url ws://127.0.0.1:18789 --token <token>
|
|
22
|
+
milaidy tui --session main --deliver
|
|
23
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy uninstall` (remove gateway service + local data)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to remove the gateway service and/or local state
|
|
5
|
+
- You want a dry-run first
|
|
6
|
+
title: "uninstall"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy uninstall`
|
|
10
|
+
|
|
11
|
+
Uninstall the gateway service + local data (CLI remains).
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
milaidy uninstall
|
|
15
|
+
milaidy uninstall --all --yes
|
|
16
|
+
milaidy uninstall --dry-run
|
|
17
|
+
```
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy update` (safe-ish source update + gateway auto-restart)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to update a source checkout safely
|
|
5
|
+
- You need to understand `--update` shorthand behavior
|
|
6
|
+
title: "update"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy update`
|
|
10
|
+
|
|
11
|
+
Safely update Milaidy and switch between stable/beta/dev channels.
|
|
12
|
+
|
|
13
|
+
If you installed via **npm/pnpm** (global install, no git metadata), updates happen via the package manager flow in [Updating](/install/updating).
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
milaidy update
|
|
19
|
+
milaidy update status
|
|
20
|
+
milaidy update wizard
|
|
21
|
+
milaidy update --channel beta
|
|
22
|
+
milaidy update --channel dev
|
|
23
|
+
milaidy update --tag beta
|
|
24
|
+
milaidy update --no-restart
|
|
25
|
+
milaidy update --json
|
|
26
|
+
milaidy --update
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Options
|
|
30
|
+
|
|
31
|
+
- `--no-restart`: skip restarting the Gateway service after a successful update.
|
|
32
|
+
- `--channel <stable|beta|dev>`: set the update channel (git + npm; persisted in config).
|
|
33
|
+
- `--tag <dist-tag|version>`: override the npm dist-tag or version for this update only.
|
|
34
|
+
- `--json`: print machine-readable `UpdateRunResult` JSON.
|
|
35
|
+
- `--timeout <seconds>`: per-step timeout (default is 1200s).
|
|
36
|
+
|
|
37
|
+
Note: downgrades require confirmation because older versions can break configuration.
|
|
38
|
+
|
|
39
|
+
## `update status`
|
|
40
|
+
|
|
41
|
+
Show the active update channel + git tag/branch/SHA (for source checkouts), plus update availability.
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
milaidy update status
|
|
45
|
+
milaidy update status --json
|
|
46
|
+
milaidy update status --timeout 10
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Options:
|
|
50
|
+
|
|
51
|
+
- `--json`: print machine-readable status JSON.
|
|
52
|
+
- `--timeout <seconds>`: timeout for checks (default is 3s).
|
|
53
|
+
|
|
54
|
+
## `update wizard`
|
|
55
|
+
|
|
56
|
+
Interactive flow to pick an update channel and confirm whether to restart the Gateway
|
|
57
|
+
after updating (default is to restart). If you select `dev` without a git checkout, it
|
|
58
|
+
offers to create one.
|
|
59
|
+
|
|
60
|
+
## What it does
|
|
61
|
+
|
|
62
|
+
When you switch channels explicitly (`--channel ...`), Milaidy also keeps the
|
|
63
|
+
install method aligned:
|
|
64
|
+
|
|
65
|
+
- `dev` → ensures a git checkout (default: `~/milaidy`, override with `MILAIDY_GIT_DIR`),
|
|
66
|
+
updates it, and installs the global CLI from that checkout.
|
|
67
|
+
- `stable`/`beta` → installs from npm using the matching dist-tag.
|
|
68
|
+
|
|
69
|
+
## Git checkout flow
|
|
70
|
+
|
|
71
|
+
Channels:
|
|
72
|
+
|
|
73
|
+
- `stable`: checkout the latest non-beta tag, then build + doctor.
|
|
74
|
+
- `beta`: checkout the latest `-beta` tag, then build + doctor.
|
|
75
|
+
- `dev`: checkout `main`, then fetch + rebase.
|
|
76
|
+
|
|
77
|
+
High-level:
|
|
78
|
+
|
|
79
|
+
1. Requires a clean worktree (no uncommitted changes).
|
|
80
|
+
2. Switches to the selected channel (tag or branch).
|
|
81
|
+
3. Fetches upstream (dev only).
|
|
82
|
+
4. Dev only: preflight lint + TypeScript build in a temp worktree; if the tip fails, walks back up to 10 commits to find the newest clean build.
|
|
83
|
+
5. Rebases onto the selected commit (dev only).
|
|
84
|
+
6. Installs deps (pnpm preferred; npm fallback).
|
|
85
|
+
7. Builds + builds the Control UI.
|
|
86
|
+
8. Runs `milaidy doctor` as the final “safe update” check.
|
|
87
|
+
9. Syncs plugins to the active channel (dev uses bundled extensions; stable/beta uses npm) and updates npm-installed plugins.
|
|
88
|
+
|
|
89
|
+
## `--update` shorthand
|
|
90
|
+
|
|
91
|
+
`milaidy --update` rewrites to `milaidy update` (useful for shells and launcher scripts).
|
|
92
|
+
|
|
93
|
+
## See also
|
|
94
|
+
|
|
95
|
+
- `milaidy doctor` (offers to run update first on git checkouts)
|
|
96
|
+
- [Development channels](/install/development-channels)
|
|
97
|
+
- [Updating](/install/updating)
|
|
98
|
+
- [CLI reference](/cli)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy voicecall` (voice-call plugin command surface)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You use the voice-call plugin and want the CLI entry points
|
|
5
|
+
- You want quick examples for `voicecall call|continue|status|tail|expose`
|
|
6
|
+
title: "voicecall"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy voicecall`
|
|
10
|
+
|
|
11
|
+
`voicecall` is a plugin-provided command. It only appears if the voice-call plugin is installed and enabled.
|
|
12
|
+
|
|
13
|
+
Primary doc:
|
|
14
|
+
|
|
15
|
+
- Voice-call plugin: [Voice Call](/plugins/voice-call)
|
|
16
|
+
|
|
17
|
+
## Common commands
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
milaidy voicecall status --call-id <id>
|
|
21
|
+
milaidy voicecall call --to "+15555550123" --message "Hello" --mode notify
|
|
22
|
+
milaidy voicecall continue --call-id <id> --message "Any questions?"
|
|
23
|
+
milaidy voicecall end --call-id <id>
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Exposing webhooks (Tailscale)
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
milaidy voicecall expose --mode serve
|
|
30
|
+
milaidy voicecall expose --mode funnel
|
|
31
|
+
milaidy voicecall unexpose
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Security note: only expose the webhook endpoint to networks you trust. Prefer Tailscale Serve over Funnel when possible.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `milaidy webhooks` (webhook helpers + Gmail Pub/Sub)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to wire Gmail Pub/Sub events into Milaidy
|
|
5
|
+
- You want webhook helper commands
|
|
6
|
+
title: "webhooks"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `milaidy webhooks`
|
|
10
|
+
|
|
11
|
+
Webhook helpers and integrations (Gmail Pub/Sub, webhook helpers).
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Webhooks: [Webhook](/automation/webhook)
|
|
16
|
+
- Gmail Pub/Sub: [Gmail Pub/Sub](/automation/gmail-pubsub)
|
|
17
|
+
|
|
18
|
+
## Gmail
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
milaidy webhooks gmail setup --account you@example.com
|
|
22
|
+
milaidy webhooks gmail run
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
See [Gmail Pub/Sub documentation](/automation/gmail-pubsub) for details.
|