nodmix 2026.5.25
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/CHANGELOG.md +11573 -0
- package/LICENSE +21 -0
- package/README.md +486 -0
- package/docs/.i18n/README.md +81 -0
- package/docs/.i18n/ar-navigation.json +18 -0
- package/docs/.i18n/de-navigation.json +18 -0
- package/docs/.i18n/es-navigation.json +18 -0
- package/docs/.i18n/fr-navigation.json +18 -0
- package/docs/.i18n/glossary.ar.json +78 -0
- package/docs/.i18n/glossary.de.json +78 -0
- package/docs/.i18n/glossary.es.json +78 -0
- package/docs/.i18n/glossary.fa.json +78 -0
- package/docs/.i18n/glossary.fr.json +78 -0
- package/docs/.i18n/glossary.id.json +78 -0
- package/docs/.i18n/glossary.it.json +78 -0
- package/docs/.i18n/glossary.ja-JP.json +98 -0
- package/docs/.i18n/glossary.ko.json +78 -0
- package/docs/.i18n/glossary.nl.json +78 -0
- package/docs/.i18n/glossary.pl.json +78 -0
- package/docs/.i18n/glossary.pt-BR.json +78 -0
- package/docs/.i18n/glossary.th.json +78 -0
- package/docs/.i18n/glossary.tr.json +78 -0
- package/docs/.i18n/glossary.uk.json +78 -0
- package/docs/.i18n/glossary.vi.json +78 -0
- package/docs/.i18n/glossary.zh-CN.json +1002 -0
- package/docs/.i18n/glossary.zh-TW.json +78 -0
- package/docs/.i18n/id-navigation.json +18 -0
- package/docs/.i18n/it-navigation.json +18 -0
- package/docs/.i18n/ja-navigation.json +18 -0
- package/docs/.i18n/ko-navigation.json +18 -0
- package/docs/.i18n/pl-navigation.json +18 -0
- package/docs/.i18n/pt-BR-navigation.json +18 -0
- package/docs/.i18n/tr-navigation.json +18 -0
- package/docs/.i18n/translation-workflow.md +111 -0
- package/docs/.i18n/zh-Hans-navigation.json +542 -0
- package/docs/AGENTS.md +36 -0
- package/docs/announcements/bluebubbles-imessage.md +79 -0
- package/docs/assets/install-script.svg +1 -0
- package/docs/assets/macos-onboarding/01-macos-warning.jpeg +0 -0
- package/docs/assets/macos-onboarding/02-local-networks.jpeg +0 -0
- package/docs/assets/macos-onboarding/03-security-notice.png +0 -0
- package/docs/assets/macos-onboarding/04-choose-gateway.png +0 -0
- package/docs/assets/macos-onboarding/05-permissions.png +0 -0
- package/docs/assets/openclaw-logo-text-dark.png +0 -0
- package/docs/assets/openclaw-logo-text-dark.svg +418 -0
- package/docs/assets/openclaw-logo-text.png +0 -0
- package/docs/assets/openclaw-logo-text.svg +418 -0
- package/docs/assets/pixel-lobster.svg +60 -0
- package/docs/assets/pr/quick-settings-browser-tools.png +0 -0
- package/docs/assets/showcase/agents-ui.jpg +0 -0
- package/docs/assets/showcase/bambu-cli.png +0 -0
- package/docs/assets/showcase/codexmonitor.png +0 -0
- package/docs/assets/showcase/gohome-grafana.png +0 -0
- package/docs/assets/showcase/ios-testflight.jpg +0 -0
- package/docs/assets/showcase/oura-health.png +0 -0
- package/docs/assets/showcase/padel-cli.svg +11 -0
- package/docs/assets/showcase/padel-screenshot.jpg +0 -0
- package/docs/assets/showcase/papla-tts.jpg +0 -0
- package/docs/assets/showcase/pr-review-telegram.jpg +0 -0
- package/docs/assets/showcase/roborock-screenshot.jpg +0 -0
- package/docs/assets/showcase/roborock-status.svg +13 -0
- package/docs/assets/showcase/roof-camera-sky.jpg +0 -0
- package/docs/assets/showcase/snag.png +0 -0
- package/docs/assets/showcase/tesco-shop.jpg +0 -0
- package/docs/assets/showcase/wienerlinien.png +0 -0
- package/docs/assets/showcase/wine-cellar-skill.jpg +0 -0
- package/docs/assets/showcase/winix-air-purifier.jpg +0 -0
- package/docs/assets/showcase/xuezh-pronunciation.jpeg +0 -0
- package/docs/assets/sponsors/blacksmith-light.svg +14 -0
- package/docs/assets/sponsors/blacksmith.svg +14 -0
- package/docs/assets/sponsors/convex-light.svg +16 -0
- package/docs/assets/sponsors/convex.svg +16 -0
- package/docs/assets/sponsors/github-light.svg +3 -0
- package/docs/assets/sponsors/github.svg +3 -0
- package/docs/assets/sponsors/nvidia-dark.svg +9 -0
- package/docs/assets/sponsors/nvidia.svg +9 -0
- package/docs/assets/sponsors/openai-light.svg +3 -0
- package/docs/assets/sponsors/openai.svg +3 -0
- package/docs/assets/sponsors/vercel-light.svg +5 -0
- package/docs/assets/sponsors/vercel.svg +5 -0
- package/docs/auth-credential-semantics.md +124 -0
- package/docs/automation/auth-monitoring.md +11 -0
- package/docs/automation/clawflow.md +12 -0
- package/docs/automation/cron-jobs.md +500 -0
- package/docs/automation/cron-vs-heartbeat.md +11 -0
- package/docs/automation/gmail-pubsub.md +11 -0
- package/docs/automation/hooks.md +365 -0
- package/docs/automation/index.md +135 -0
- package/docs/automation/poll.md +12 -0
- package/docs/automation/standing-orders.md +250 -0
- package/docs/automation/taskflow.md +155 -0
- package/docs/automation/tasks.md +374 -0
- package/docs/automation/troubleshooting.md +12 -0
- package/docs/automation/webhook.md +12 -0
- package/docs/brave-search.md +11 -0
- package/docs/channels/access-groups.md +201 -0
- package/docs/channels/ambient-room-events.md +214 -0
- package/docs/channels/bot-loop-protection.md +131 -0
- package/docs/channels/broadcast-groups.md +472 -0
- package/docs/channels/channel-routing.md +162 -0
- package/docs/channels/clickclack.md +138 -0
- package/docs/channels/discord.md +1762 -0
- package/docs/channels/feishu.md +502 -0
- package/docs/channels/googlechat.md +284 -0
- package/docs/channels/group-messages.md +95 -0
- package/docs/channels/groups.md +519 -0
- package/docs/channels/imessage-from-bluebubbles.md +259 -0
- package/docs/channels/imessage.md +813 -0
- package/docs/channels/index.md +64 -0
- package/docs/channels/irc.md +253 -0
- package/docs/channels/line.md +243 -0
- package/docs/channels/location.md +71 -0
- package/docs/channels/matrix-migration.md +370 -0
- package/docs/channels/matrix-presentation.md +77 -0
- package/docs/channels/matrix-push-rules.md +150 -0
- package/docs/channels/matrix.md +921 -0
- package/docs/channels/mattermost.md +542 -0
- package/docs/channels/msteams.md +1042 -0
- package/docs/channels/nextcloud-talk.md +176 -0
- package/docs/channels/nostr.md +253 -0
- package/docs/channels/pairing.md +214 -0
- package/docs/channels/qqbot.md +309 -0
- package/docs/channels/signal.md +400 -0
- package/docs/channels/slack.md +1564 -0
- package/docs/channels/synology-chat.md +187 -0
- package/docs/channels/telegram.md +1107 -0
- package/docs/channels/tlon.md +296 -0
- package/docs/channels/troubleshooting.md +161 -0
- package/docs/channels/twitch.md +431 -0
- package/docs/channels/wechat.md +171 -0
- package/docs/channels/whatsapp.md +739 -0
- package/docs/channels/yuanbao.md +416 -0
- package/docs/channels/zalo.md +253 -0
- package/docs/channels/zalouser.md +199 -0
- package/docs/ci.md +612 -0
- package/docs/clawhub/publishing.md +96 -0
- package/docs/cli/acp.md +370 -0
- package/docs/cli/agent.md +103 -0
- package/docs/cli/agents.md +232 -0
- package/docs/cli/approvals.md +190 -0
- package/docs/cli/backup.md +97 -0
- package/docs/cli/browser.md +307 -0
- package/docs/cli/channels.md +154 -0
- package/docs/cli/clawbot.md +25 -0
- package/docs/cli/commitments.md +90 -0
- package/docs/cli/completion.md +39 -0
- package/docs/cli/config.md +504 -0
- package/docs/cli/configure.md +77 -0
- package/docs/cli/crestodian.md +332 -0
- package/docs/cli/cron.md +281 -0
- package/docs/cli/daemon.md +67 -0
- package/docs/cli/dashboard.md +33 -0
- package/docs/cli/devices.md +204 -0
- package/docs/cli/directory.md +68 -0
- package/docs/cli/dns.md +53 -0
- package/docs/cli/docs.md +73 -0
- package/docs/cli/doctor.md +237 -0
- package/docs/cli/flows.md +52 -0
- package/docs/cli/gateway.md +567 -0
- package/docs/cli/health.md +43 -0
- package/docs/cli/hooks.md +345 -0
- package/docs/cli/index.md +396 -0
- package/docs/cli/infer.md +364 -0
- package/docs/cli/logs.md +65 -0
- package/docs/cli/mcp.md +529 -0
- package/docs/cli/memory.md +183 -0
- package/docs/cli/message.md +317 -0
- package/docs/cli/migrate.md +290 -0
- package/docs/cli/models.md +224 -0
- package/docs/cli/node.md +177 -0
- package/docs/cli/nodes.md +76 -0
- package/docs/cli/onboard.md +245 -0
- package/docs/cli/pairing.md +77 -0
- package/docs/cli/path.md +502 -0
- package/docs/cli/plugins.md +454 -0
- package/docs/cli/policy.md +418 -0
- package/docs/cli/proxy.md +89 -0
- package/docs/cli/qr.md +56 -0
- package/docs/cli/reset.md +39 -0
- package/docs/cli/sandbox.md +208 -0
- package/docs/cli/secrets.md +202 -0
- package/docs/cli/security.md +124 -0
- package/docs/cli/sessions.md +164 -0
- package/docs/cli/setup.md +59 -0
- package/docs/cli/skills.md +102 -0
- package/docs/cli/status.md +45 -0
- package/docs/cli/system.md +89 -0
- package/docs/cli/tasks.md +111 -0
- package/docs/cli/tui.md +89 -0
- package/docs/cli/uninstall.md +44 -0
- package/docs/cli/update.md +242 -0
- package/docs/cli/voicecall.md +204 -0
- package/docs/cli/webhooks.md +117 -0
- package/docs/cli/wiki.md +256 -0
- package/docs/concepts/active-memory.md +856 -0
- package/docs/concepts/agent-loop.md +185 -0
- package/docs/concepts/agent-runtimes.md +243 -0
- package/docs/concepts/agent-workspace.md +230 -0
- package/docs/concepts/agent.md +136 -0
- package/docs/concepts/architecture.md +154 -0
- package/docs/concepts/channel-docking.md +145 -0
- package/docs/concepts/commitments.md +150 -0
- package/docs/concepts/compaction.md +203 -0
- package/docs/concepts/context-engine.md +306 -0
- package/docs/concepts/context.md +199 -0
- package/docs/concepts/delegate-architecture.md +319 -0
- package/docs/concepts/dreaming.md +261 -0
- package/docs/concepts/experimental-features.md +108 -0
- package/docs/concepts/features.md +91 -0
- package/docs/concepts/mantis-slack-desktop-runbook.md +202 -0
- package/docs/concepts/mantis.md +740 -0
- package/docs/concepts/markdown-formatting.md +139 -0
- package/docs/concepts/memory-builtin.md +146 -0
- package/docs/concepts/memory-honcho.md +144 -0
- package/docs/concepts/memory-qmd.md +271 -0
- package/docs/concepts/memory-search.md +166 -0
- package/docs/concepts/memory.md +258 -0
- package/docs/concepts/message-lifecycle-refactor.md +1128 -0
- package/docs/concepts/messages.md +214 -0
- package/docs/concepts/model-failover.md +385 -0
- package/docs/concepts/model-providers.md +715 -0
- package/docs/concepts/models.md +370 -0
- package/docs/concepts/multi-agent.md +619 -0
- package/docs/concepts/oauth.md +198 -0
- package/docs/concepts/openclaw-sdk.md +323 -0
- package/docs/concepts/parallel-specialist-lanes.md +127 -0
- package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
- package/docs/concepts/presence.md +117 -0
- package/docs/concepts/progress-drafts.md +362 -0
- package/docs/concepts/qa-e2e-automation.md +820 -0
- package/docs/concepts/qa-matrix.md +139 -0
- package/docs/concepts/queue-steering.md +90 -0
- package/docs/concepts/queue.md +122 -0
- package/docs/concepts/retry.md +86 -0
- package/docs/concepts/session-pruning.md +104 -0
- package/docs/concepts/session-tool.md +190 -0
- package/docs/concepts/session.md +164 -0
- package/docs/concepts/soul.md +116 -0
- package/docs/concepts/streaming.md +251 -0
- package/docs/concepts/system-prompt.md +310 -0
- package/docs/concepts/timezone.md +47 -0
- package/docs/concepts/typebox.md +309 -0
- package/docs/concepts/typing-indicators.md +88 -0
- package/docs/concepts/usage-tracking.md +66 -0
- package/docs/date-time.md +126 -0
- package/docs/debug/node-issue.md +90 -0
- package/docs/diagnostics/flags.md +138 -0
- package/docs/docs.json +1832 -0
- package/docs/gateway/authentication.md +239 -0
- package/docs/gateway/background-process.md +147 -0
- package/docs/gateway/bonjour.md +303 -0
- package/docs/gateway/bridge-protocol.md +94 -0
- package/docs/gateway/cli-backends.md +420 -0
- package/docs/gateway/config-agents.md +1514 -0
- package/docs/gateway/config-channels.md +945 -0
- package/docs/gateway/config-tools.md +769 -0
- package/docs/gateway/configuration-examples.md +705 -0
- package/docs/gateway/configuration-reference.md +1393 -0
- package/docs/gateway/configuration.md +737 -0
- package/docs/gateway/diagnostics.md +213 -0
- package/docs/gateway/discovery.md +154 -0
- package/docs/gateway/doctor.md +574 -0
- package/docs/gateway/gateway-lock.md +37 -0
- package/docs/gateway/health.md +73 -0
- package/docs/gateway/heartbeat.md +493 -0
- package/docs/gateway/index.md +383 -0
- package/docs/gateway/local-model-services.md +205 -0
- package/docs/gateway/local-models.md +355 -0
- package/docs/gateway/logging.md +149 -0
- package/docs/gateway/multiple-gateways.md +178 -0
- package/docs/gateway/network-model.md +15 -0
- package/docs/gateway/openai-http-api.md +350 -0
- package/docs/gateway/openresponses-http-api.md +347 -0
- package/docs/gateway/openshell.md +316 -0
- package/docs/gateway/opentelemetry.md +404 -0
- package/docs/gateway/operator-scopes.md +111 -0
- package/docs/gateway/pairing.md +207 -0
- package/docs/gateway/prometheus.md +230 -0
- package/docs/gateway/protocol.md +803 -0
- package/docs/gateway/remote-gateway-readme.md +169 -0
- package/docs/gateway/remote.md +280 -0
- package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +146 -0
- package/docs/gateway/sandboxing.md +545 -0
- package/docs/gateway/secrets-plan-contract.md +114 -0
- package/docs/gateway/secrets.md +609 -0
- package/docs/gateway/security/audit-checks.md +127 -0
- package/docs/gateway/security/index.md +1326 -0
- package/docs/gateway/security/secure-file-operations.md +76 -0
- package/docs/gateway/tailscale.md +156 -0
- package/docs/gateway/tools-invoke-http-api.md +169 -0
- package/docs/gateway/troubleshooting.md +772 -0
- package/docs/gateway/trusted-proxy-auth.md +451 -0
- package/docs/help/debugging.md +344 -0
- package/docs/help/environment.md +214 -0
- package/docs/help/faq-first-run.md +867 -0
- package/docs/help/faq-models.md +553 -0
- package/docs/help/faq.md +1975 -0
- package/docs/help/gpt55-codex-agentic-parity-maintainers.md +196 -0
- package/docs/help/gpt55-codex-agentic-parity.md +230 -0
- package/docs/help/index.md +39 -0
- package/docs/help/scripts.md +56 -0
- package/docs/help/testing-live.md +580 -0
- package/docs/help/testing-updates-plugins.md +291 -0
- package/docs/help/testing.md +928 -0
- package/docs/help/troubleshooting.md +424 -0
- package/docs/images/configure-model-picker-unsearchable.png +0 -0
- package/docs/images/feishu-get-group-id.png +0 -0
- package/docs/images/groups-flow.svg +52 -0
- package/docs/images/mobile-ui-screenshot.png +0 -0
- package/docs/index.md +196 -0
- package/docs/install/ansible.md +233 -0
- package/docs/install/azure.md +315 -0
- package/docs/install/bun.md +59 -0
- package/docs/install/clawdock.md +112 -0
- package/docs/install/development-channels.md +135 -0
- package/docs/install/digitalocean.md +174 -0
- package/docs/install/docker-vm-runtime.md +154 -0
- package/docs/install/docker.md +562 -0
- package/docs/install/exe-dev.md +201 -0
- package/docs/install/fly.md +524 -0
- package/docs/install/gcp.md +418 -0
- package/docs/install/hetzner.md +285 -0
- package/docs/install/hostinger.md +98 -0
- package/docs/install/index.md +221 -0
- package/docs/install/installer.md +455 -0
- package/docs/install/kubernetes.md +196 -0
- package/docs/install/macos-vm.md +281 -0
- package/docs/install/migrating-claude.md +165 -0
- package/docs/install/migrating-hermes.md +177 -0
- package/docs/install/migrating.md +137 -0
- package/docs/install/nix.md +112 -0
- package/docs/install/node.md +142 -0
- package/docs/install/northflank.mdx +44 -0
- package/docs/install/oracle.md +218 -0
- package/docs/install/podman.md +210 -0
- package/docs/install/railway.mdx +92 -0
- package/docs/install/raspberry-pi.md +234 -0
- package/docs/install/render.mdx +167 -0
- package/docs/install/uninstall.md +131 -0
- package/docs/install/updating.md +280 -0
- package/docs/logging.md +318 -0
- package/docs/nav-tabs-underline.js +100 -0
- package/docs/network.md +72 -0
- package/docs/nodes/audio.md +215 -0
- package/docs/nodes/camera.md +166 -0
- package/docs/nodes/images.md +77 -0
- package/docs/nodes/index.md +439 -0
- package/docs/nodes/location-command.md +102 -0
- package/docs/nodes/media-understanding.md +469 -0
- package/docs/nodes/talk.md +154 -0
- package/docs/nodes/troubleshooting.md +123 -0
- package/docs/nodes/voicewake.md +93 -0
- package/docs/perplexity.md +11 -0
- package/docs/pi-dev.md +82 -0
- package/docs/pi.md +573 -0
- package/docs/plan/codex-context-engine-harness.md +624 -0
- package/docs/plan/ui-channels.md +284 -0
- package/docs/platforms/android.md +285 -0
- package/docs/platforms/digitalocean.md +12 -0
- package/docs/platforms/index.md +60 -0
- package/docs/platforms/ios.md +283 -0
- package/docs/platforms/linux.md +141 -0
- package/docs/platforms/mac/bundled-gateway.md +79 -0
- package/docs/platforms/mac/canvas.md +128 -0
- package/docs/platforms/mac/child-process.md +72 -0
- package/docs/platforms/mac/dev-setup.md +112 -0
- package/docs/platforms/mac/health.md +39 -0
- package/docs/platforms/mac/icon.md +36 -0
- package/docs/platforms/mac/logging.md +62 -0
- package/docs/platforms/mac/menu-bar.md +93 -0
- package/docs/platforms/mac/peekaboo.md +92 -0
- package/docs/platforms/mac/permissions.md +53 -0
- package/docs/platforms/mac/remote.md +123 -0
- package/docs/platforms/mac/signing.md +52 -0
- package/docs/platforms/mac/skills.md +43 -0
- package/docs/platforms/mac/voice-overlay.md +66 -0
- package/docs/platforms/mac/voicewake.md +73 -0
- package/docs/platforms/mac/webchat.md +54 -0
- package/docs/platforms/mac/xpc.md +66 -0
- package/docs/platforms/macos.md +226 -0
- package/docs/platforms/oracle.md +12 -0
- package/docs/platforms/raspberry-pi.md +13 -0
- package/docs/platforms/windows.md +286 -0
- package/docs/plugins/adding-capabilities.md +133 -0
- package/docs/plugins/admin-http-rpc.md +216 -0
- package/docs/plugins/agent-tools.md +13 -0
- package/docs/plugins/architecture-internals.md +1195 -0
- package/docs/plugins/architecture.md +481 -0
- package/docs/plugins/building-extensions.md +13 -0
- package/docs/plugins/building-plugins.md +330 -0
- package/docs/plugins/bundles.md +310 -0
- package/docs/plugins/cli-backend-plugins.md +310 -0
- package/docs/plugins/codex-computer-use.md +293 -0
- package/docs/plugins/codex-harness-reference.md +409 -0
- package/docs/plugins/codex-harness-runtime.md +247 -0
- package/docs/plugins/codex-harness.md +746 -0
- package/docs/plugins/codex-native-plugins.md +276 -0
- package/docs/plugins/community.md +77 -0
- package/docs/plugins/compatibility.md +164 -0
- package/docs/plugins/dependency-resolution.md +143 -0
- package/docs/plugins/google-meet.md +1737 -0
- package/docs/plugins/hooks.md +459 -0
- package/docs/plugins/install-overrides.md +80 -0
- package/docs/plugins/manage-plugins.md +210 -0
- package/docs/plugins/manifest.md +1359 -0
- package/docs/plugins/memory-lancedb.md +385 -0
- package/docs/plugins/memory-wiki.md +529 -0
- package/docs/plugins/message-presentation.md +473 -0
- package/docs/plugins/oc-path.md +166 -0
- package/docs/plugins/plugin-inventory.md +182 -0
- package/docs/plugins/reference/acpx.md +23 -0
- package/docs/plugins/reference/admin-http-rpc.md +23 -0
- package/docs/plugins/reference/alibaba.md +23 -0
- package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
- package/docs/plugins/reference/amazon-bedrock.md +23 -0
- package/docs/plugins/reference/anthropic-vertex.md +19 -0
- package/docs/plugins/reference/anthropic.md +23 -0
- package/docs/plugins/reference/arcee.md +23 -0
- package/docs/plugins/reference/azure-speech.md +23 -0
- package/docs/plugins/reference/bonjour.md +19 -0
- package/docs/plugins/reference/brave.md +23 -0
- package/docs/plugins/reference/browser.md +23 -0
- package/docs/plugins/reference/byteplus.md +19 -0
- package/docs/plugins/reference/canvas.md +19 -0
- package/docs/plugins/reference/cerebras.md +23 -0
- package/docs/plugins/reference/chutes.md +23 -0
- package/docs/plugins/reference/clickclack.md +23 -0
- package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
- package/docs/plugins/reference/codex.md +23 -0
- package/docs/plugins/reference/comfy.md +23 -0
- package/docs/plugins/reference/copilot-proxy.md +19 -0
- package/docs/plugins/reference/deepgram.md +23 -0
- package/docs/plugins/reference/deepinfra.md +23 -0
- package/docs/plugins/reference/deepseek.md +23 -0
- package/docs/plugins/reference/diagnostics-otel.md +19 -0
- package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
- package/docs/plugins/reference/diffs.md +19 -0
- package/docs/plugins/reference/discord.md +23 -0
- package/docs/plugins/reference/document-extract.md +23 -0
- package/docs/plugins/reference/duckduckgo.md +23 -0
- package/docs/plugins/reference/elevenlabs.md +23 -0
- package/docs/plugins/reference/exa.md +23 -0
- package/docs/plugins/reference/fal.md +23 -0
- package/docs/plugins/reference/feishu.md +23 -0
- package/docs/plugins/reference/file-transfer.md +19 -0
- package/docs/plugins/reference/firecrawl.md +23 -0
- package/docs/plugins/reference/fireworks.md +23 -0
- package/docs/plugins/reference/github-copilot.md +23 -0
- package/docs/plugins/reference/google-meet.md +23 -0
- package/docs/plugins/reference/google.md +23 -0
- package/docs/plugins/reference/googlechat.md +23 -0
- package/docs/plugins/reference/gradium.md +23 -0
- package/docs/plugins/reference/groq.md +23 -0
- package/docs/plugins/reference/huggingface.md +23 -0
- package/docs/plugins/reference/imessage.md +23 -0
- package/docs/plugins/reference/inworld.md +23 -0
- package/docs/plugins/reference/irc.md +23 -0
- package/docs/plugins/reference/kilocode.md +23 -0
- package/docs/plugins/reference/kimi.md +23 -0
- package/docs/plugins/reference/line.md +23 -0
- package/docs/plugins/reference/litellm.md +23 -0
- package/docs/plugins/reference/llm-task.md +19 -0
- package/docs/plugins/reference/lmstudio.md +23 -0
- package/docs/plugins/reference/lobster.md +19 -0
- package/docs/plugins/reference/matrix.md +23 -0
- package/docs/plugins/reference/mattermost.md +23 -0
- package/docs/plugins/reference/memory-core.md +19 -0
- package/docs/plugins/reference/memory-lancedb.md +23 -0
- package/docs/plugins/reference/memory-wiki.md +23 -0
- package/docs/plugins/reference/microsoft-foundry.md +19 -0
- package/docs/plugins/reference/microsoft.md +19 -0
- package/docs/plugins/reference/migrate-claude.md +19 -0
- package/docs/plugins/reference/migrate-hermes.md +19 -0
- package/docs/plugins/reference/minimax.md +23 -0
- package/docs/plugins/reference/mistral.md +23 -0
- package/docs/plugins/reference/moonshot.md +23 -0
- package/docs/plugins/reference/msteams.md +23 -0
- package/docs/plugins/reference/nextcloud-talk.md +23 -0
- package/docs/plugins/reference/nostr.md +23 -0
- package/docs/plugins/reference/nvidia.md +23 -0
- package/docs/plugins/reference/oc-path.md +23 -0
- package/docs/plugins/reference/ollama.md +23 -0
- package/docs/plugins/reference/open-prose.md +19 -0
- package/docs/plugins/reference/openai.md +23 -0
- package/docs/plugins/reference/opencode-go.md +23 -0
- package/docs/plugins/reference/opencode.md +23 -0
- package/docs/plugins/reference/openrouter.md +23 -0
- package/docs/plugins/reference/openshell.md +19 -0
- package/docs/plugins/reference/perplexity.md +23 -0
- package/docs/plugins/reference/policy.md +23 -0
- package/docs/plugins/reference/qa-channel.md +23 -0
- package/docs/plugins/reference/qa-lab.md +19 -0
- package/docs/plugins/reference/qa-matrix.md +19 -0
- package/docs/plugins/reference/qianfan.md +23 -0
- package/docs/plugins/reference/qqbot.md +23 -0
- package/docs/plugins/reference/qwen.md +23 -0
- package/docs/plugins/reference/runway.md +23 -0
- package/docs/plugins/reference/searxng.md +19 -0
- package/docs/plugins/reference/senseaudio.md +23 -0
- package/docs/plugins/reference/sglang.md +23 -0
- package/docs/plugins/reference/signal.md +23 -0
- package/docs/plugins/reference/skill-workshop.md +23 -0
- package/docs/plugins/reference/slack.md +23 -0
- package/docs/plugins/reference/stepfun.md +23 -0
- package/docs/plugins/reference/synology-chat.md +23 -0
- package/docs/plugins/reference/synthetic.md +23 -0
- package/docs/plugins/reference/tavily.md +23 -0
- package/docs/plugins/reference/telegram.md +23 -0
- package/docs/plugins/reference/tencent.md +23 -0
- package/docs/plugins/reference/tlon.md +23 -0
- package/docs/plugins/reference/together.md +23 -0
- package/docs/plugins/reference/tokenjuice.md +23 -0
- package/docs/plugins/reference/tts-local-cli.md +19 -0
- package/docs/plugins/reference/twitch.md +23 -0
- package/docs/plugins/reference/venice.md +23 -0
- package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
- package/docs/plugins/reference/vllm.md +23 -0
- package/docs/plugins/reference/voice-call.md +23 -0
- package/docs/plugins/reference/volcengine.md +23 -0
- package/docs/plugins/reference/voyage.md +19 -0
- package/docs/plugins/reference/vydra.md +23 -0
- package/docs/plugins/reference/web-readability.md +19 -0
- package/docs/plugins/reference/webhooks.md +23 -0
- package/docs/plugins/reference/whatsapp.md +23 -0
- package/docs/plugins/reference/xai.md +23 -0
- package/docs/plugins/reference/xiaomi.md +23 -0
- package/docs/plugins/reference/zai.md +23 -0
- package/docs/plugins/reference/zalo.md +23 -0
- package/docs/plugins/reference/zalouser.md +24 -0
- package/docs/plugins/reference.md +138 -0
- package/docs/plugins/sdk-agent-harness.md +339 -0
- package/docs/plugins/sdk-channel-ingress.md +137 -0
- package/docs/plugins/sdk-channel-message.md +458 -0
- package/docs/plugins/sdk-channel-plugins.md +762 -0
- package/docs/plugins/sdk-channel-turn.md +580 -0
- package/docs/plugins/sdk-entrypoints.md +333 -0
- package/docs/plugins/sdk-migration.md +949 -0
- package/docs/plugins/sdk-overview.md +501 -0
- package/docs/plugins/sdk-provider-plugins.md +807 -0
- package/docs/plugins/sdk-runtime.md +676 -0
- package/docs/plugins/sdk-setup.md +550 -0
- package/docs/plugins/sdk-subpaths.md +396 -0
- package/docs/plugins/sdk-testing.md +401 -0
- package/docs/plugins/skill-workshop.md +713 -0
- package/docs/plugins/tool-plugins.md +411 -0
- package/docs/plugins/voice-call.md +943 -0
- package/docs/plugins/webhooks.md +192 -0
- package/docs/plugins/zalouser.md +86 -0
- package/docs/prose.md +137 -0
- package/docs/providers/alibaba.md +158 -0
- package/docs/providers/anthropic.md +344 -0
- package/docs/providers/arcee.md +144 -0
- package/docs/providers/azure-speech.md +119 -0
- package/docs/providers/bedrock-mantle.md +211 -0
- package/docs/providers/bedrock.md +414 -0
- package/docs/providers/cerebras.md +130 -0
- package/docs/providers/chutes.md +153 -0
- package/docs/providers/claude-max-api-proxy.md +188 -0
- package/docs/providers/cloudflare-ai-gateway.md +119 -0
- package/docs/providers/comfy.md +362 -0
- package/docs/providers/deepgram.md +184 -0
- package/docs/providers/deepinfra.md +87 -0
- package/docs/providers/deepseek.md +146 -0
- package/docs/providers/ds4.md +309 -0
- package/docs/providers/elevenlabs.md +130 -0
- package/docs/providers/fal.md +204 -0
- package/docs/providers/fireworks.md +144 -0
- package/docs/providers/github-copilot.md +225 -0
- package/docs/providers/glm.md +137 -0
- package/docs/providers/google.md +472 -0
- package/docs/providers/gradium.md +123 -0
- package/docs/providers/groq.md +180 -0
- package/docs/providers/huggingface.md +235 -0
- package/docs/providers/index.md +102 -0
- package/docs/providers/inferrs.md +272 -0
- package/docs/providers/inworld.md +120 -0
- package/docs/providers/kilocode.md +135 -0
- package/docs/providers/litellm.md +234 -0
- package/docs/providers/lmstudio.md +224 -0
- package/docs/providers/minimax.md +505 -0
- package/docs/providers/mistral.md +235 -0
- package/docs/providers/models.md +65 -0
- package/docs/providers/moonshot.md +413 -0
- package/docs/providers/nvidia.md +140 -0
- package/docs/providers/ollama.md +1180 -0
- package/docs/providers/openai.md +1057 -0
- package/docs/providers/opencode-go.md +123 -0
- package/docs/providers/opencode.md +149 -0
- package/docs/providers/openrouter.md +349 -0
- package/docs/providers/perplexity-provider.md +123 -0
- package/docs/providers/qianfan.md +132 -0
- package/docs/providers/qwen.md +332 -0
- package/docs/providers/runway.md +103 -0
- package/docs/providers/senseaudio.md +68 -0
- package/docs/providers/sglang.md +161 -0
- package/docs/providers/stepfun.md +229 -0
- package/docs/providers/synthetic.md +154 -0
- package/docs/providers/tencent.md +130 -0
- package/docs/providers/together.md +141 -0
- package/docs/providers/venice.md +315 -0
- package/docs/providers/vercel-ai-gateway.md +128 -0
- package/docs/providers/vllm.md +383 -0
- package/docs/providers/volcengine.md +199 -0
- package/docs/providers/vydra.md +180 -0
- package/docs/providers/xai.md +560 -0
- package/docs/providers/xiaomi.md +188 -0
- package/docs/providers/zai.md +203 -0
- package/docs/refactor/access.md +9 -0
- package/docs/refactor/acp.md +298 -0
- package/docs/refactor/canvas.md +131 -0
- package/docs/refactor/ingress-core.md +341 -0
- package/docs/reference/AGENTS.default.md +129 -0
- package/docs/reference/RELEASING.md +767 -0
- package/docs/reference/api-usage-costs.md +202 -0
- package/docs/reference/application-modernization-plan.md +208 -0
- package/docs/reference/code-mode.md +757 -0
- package/docs/reference/credits.md +33 -0
- package/docs/reference/device-models.md +50 -0
- package/docs/reference/full-release-validation.md +202 -0
- package/docs/reference/memory-config.md +630 -0
- package/docs/reference/openclaw-sdk-api-design.md +390 -0
- package/docs/reference/prompt-caching.md +358 -0
- package/docs/reference/rich-output-protocol.md +79 -0
- package/docs/reference/rpc.md +43 -0
- package/docs/reference/secretref-credential-surface.md +159 -0
- package/docs/reference/secretref-user-supplied-credentials-matrix.json +663 -0
- package/docs/reference/session-management-compaction.md +461 -0
- package/docs/reference/templates/AGENTS.dev.md +89 -0
- package/docs/reference/templates/AGENTS.md +225 -0
- package/docs/reference/templates/BOOT.md +16 -0
- package/docs/reference/templates/BOOTSTRAP.md +66 -0
- package/docs/reference/templates/HEARTBEAT.md +16 -0
- package/docs/reference/templates/IDENTITY.dev.md +52 -0
- package/docs/reference/templates/IDENTITY.md +34 -0
- package/docs/reference/templates/SOUL.dev.md +82 -0
- package/docs/reference/templates/SOUL.md +49 -0
- package/docs/reference/templates/TOOLS.dev.md +29 -0
- package/docs/reference/templates/TOOLS.md +51 -0
- package/docs/reference/templates/USER.dev.md +23 -0
- package/docs/reference/templates/USER.md +28 -0
- package/docs/reference/test.md +239 -0
- package/docs/reference/token-use.md +233 -0
- package/docs/reference/transcript-hygiene.md +214 -0
- package/docs/reference/wizard.md +252 -0
- package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
- package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
- package/docs/security/formal-verification.md +170 -0
- package/docs/security/incident-response.md +59 -0
- package/docs/security/network-proxy.md +268 -0
- package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
- package/docs/snippets/plugin-publish/minimal-package.json +16 -0
- package/docs/start/bootstrapping.md +49 -0
- package/docs/start/docs-directory.md +69 -0
- package/docs/start/getting-started.md +152 -0
- package/docs/start/hubs.md +201 -0
- package/docs/start/lore.md +223 -0
- package/docs/start/onboarding-overview.md +72 -0
- package/docs/start/onboarding.md +95 -0
- package/docs/start/openclaw.md +244 -0
- package/docs/start/quickstart.md +25 -0
- package/docs/start/setup.md +178 -0
- package/docs/start/showcase.md +383 -0
- package/docs/start/wizard-cli-automation.md +232 -0
- package/docs/start/wizard-cli-reference.md +331 -0
- package/docs/start/wizard.md +141 -0
- package/docs/style.css +184 -0
- package/docs/superpowers/specs/2026-04-22-tweakcn-custom-theme-import-design.md +316 -0
- package/docs/tools/acp-agents-setup.md +352 -0
- package/docs/tools/acp-agents.md +847 -0
- package/docs/tools/agent-send.md +112 -0
- package/docs/tools/apply-patch.md +64 -0
- package/docs/tools/brave-search.md +139 -0
- package/docs/tools/browser-control.md +391 -0
- package/docs/tools/browser-linux-troubleshooting.md +173 -0
- package/docs/tools/browser-login.md +77 -0
- package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
- package/docs/tools/browser.md +769 -0
- package/docs/tools/btw.md +159 -0
- package/docs/tools/capability-cookbook.md +12 -0
- package/docs/tools/clawhub.md +5 -0
- package/docs/tools/code-execution.md +173 -0
- package/docs/tools/creating-skills.md +120 -0
- package/docs/tools/diffs.md +506 -0
- package/docs/tools/duckduckgo-search.md +109 -0
- package/docs/tools/elevated.md +128 -0
- package/docs/tools/exa-search.md +152 -0
- package/docs/tools/exec-approvals-advanced.md +360 -0
- package/docs/tools/exec-approvals.md +474 -0
- package/docs/tools/exec.md +282 -0
- package/docs/tools/firecrawl.md +155 -0
- package/docs/tools/gemini-search.md +114 -0
- package/docs/tools/grok-search.md +113 -0
- package/docs/tools/image-generation.md +433 -0
- package/docs/tools/index.md +178 -0
- package/docs/tools/kimi-search.md +105 -0
- package/docs/tools/llm-task.md +137 -0
- package/docs/tools/lobster.md +365 -0
- package/docs/tools/loop-detection.md +154 -0
- package/docs/tools/media-overview.md +157 -0
- package/docs/tools/minimax-search.md +102 -0
- package/docs/tools/multi-agent-sandbox-tools.md +409 -0
- package/docs/tools/music-generation.md +371 -0
- package/docs/tools/ollama-search.md +153 -0
- package/docs/tools/pdf.md +195 -0
- package/docs/tools/perplexity-search.md +220 -0
- package/docs/tools/plugin.md +327 -0
- package/docs/tools/reactions.md +100 -0
- package/docs/tools/searxng-search.md +141 -0
- package/docs/tools/skills-config.md +195 -0
- package/docs/tools/skills.md +535 -0
- package/docs/tools/slash-commands.md +488 -0
- package/docs/tools/steer.md +84 -0
- package/docs/tools/subagents.md +650 -0
- package/docs/tools/tavily.md +162 -0
- package/docs/tools/thinking.md +140 -0
- package/docs/tools/tokenjuice.md +81 -0
- package/docs/tools/tool-search.md +269 -0
- package/docs/tools/trajectory.md +229 -0
- package/docs/tools/tts.md +1004 -0
- package/docs/tools/video-generation.md +552 -0
- package/docs/tools/web-fetch.md +195 -0
- package/docs/tools/web.md +459 -0
- package/docs/tts.md +11 -0
- package/docs/vps.md +139 -0
- package/docs/web/control-ui.md +503 -0
- package/docs/web/dashboard.md +107 -0
- package/docs/web/index.md +133 -0
- package/docs/web/tui.md +246 -0
- package/docs/web/webchat.md +99 -0
- package/docs/whatsapp-openclaw-ai-zh.jpg +0 -0
- package/docs/whatsapp-openclaw.jpg +0 -0
- package/nodmix.mjs +487 -0
- package/package.json +1852 -0
- package/patches/.gitkeep +0 -0
- package/patches/@agentclientprotocol__claude-agent-acp@0.36.1.patch +41 -0
- package/pnpm-workspace.yaml +63 -0
- package/scripts/crabbox-wrapper.mjs +353 -0
- package/scripts/lib/official-external-channel-catalog.json +559 -0
- package/scripts/lib/official-external-plugin-catalog.json +192 -0
- package/scripts/lib/official-external-provider-catalog.json +117 -0
- package/scripts/lib/package-dist-imports.mjs +171 -0
- package/scripts/npm-runner.mjs +91 -0
- package/scripts/postinstall-bundled-plugins.mjs +978 -0
- package/scripts/preinstall-package-manager-warning.mjs +64 -0
- package/scripts/windows-cmd-helpers.mjs +20 -0
- package/skills/1password/SKILL.md +70 -0
- package/skills/1password/references/cli-examples.md +29 -0
- package/skills/1password/references/get-started.md +17 -0
- package/skills/apple-notes/SKILL.md +77 -0
- package/skills/apple-reminders/SKILL.md +118 -0
- package/skills/bear-notes/SKILL.md +107 -0
- package/skills/blogwatcher/SKILL.md +69 -0
- package/skills/blucli/SKILL.md +47 -0
- package/skills/camsnap/SKILL.md +45 -0
- package/skills/canvas/SKILL.md +78 -0
- package/skills/clawhub/SKILL.md +77 -0
- package/skills/coding-agent/SKILL.md +149 -0
- package/skills/diagram-maker/SKILL.md +53 -0
- package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
- package/skills/diagram-maker/references/svg-template.md +112 -0
- package/skills/discord/SKILL.md +136 -0
- package/skills/eightctl/SKILL.md +50 -0
- package/skills/gemini/SKILL.md +47 -0
- package/skills/gh-issues/SKILL.md +213 -0
- package/skills/gifgrep/SKILL.md +85 -0
- package/skills/github/SKILL.md +84 -0
- package/skills/gog/SKILL.md +116 -0
- package/skills/goplaces/SKILL.md +52 -0
- package/skills/healthcheck/SKILL.md +105 -0
- package/skills/himalaya/SKILL.md +80 -0
- package/skills/himalaya/references/configuration.md +184 -0
- package/skills/himalaya/references/message-composition.md +199 -0
- package/skills/imsg/SKILL.md +122 -0
- package/skills/mcporter/SKILL.md +61 -0
- package/skills/meme-maker/SKILL.md +42 -0
- package/skills/meme-maker/references/templates.json +358 -0
- package/skills/meme-maker/scripts/meme.mjs +398 -0
- package/skills/model-usage/SKILL.md +69 -0
- package/skills/model-usage/references/codexbar-cli.md +33 -0
- package/skills/model-usage/scripts/model_usage.py +319 -0
- package/skills/model-usage/scripts/test_model_usage.py +40 -0
- package/skills/nano-pdf/SKILL.md +38 -0
- package/skills/node-connect/SKILL.md +142 -0
- package/skills/node-inspect-debugger/SKILL.md +85 -0
- package/skills/notion/SKILL.md +150 -0
- package/skills/obsidian/SKILL.md +119 -0
- package/skills/openai-whisper/SKILL.md +38 -0
- package/skills/openai-whisper-api/SKILL.md +71 -0
- package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
- package/skills/openhue/SKILL.md +112 -0
- package/skills/oracle/SKILL.md +126 -0
- package/skills/ordercli/SKILL.md +78 -0
- package/skills/peekaboo/SKILL.md +190 -0
- package/skills/pyproject.toml +10 -0
- package/skills/python-debugpy/SKILL.md +73 -0
- package/skills/sag/SKILL.md +87 -0
- package/skills/session-logs/SKILL.md +151 -0
- package/skills/sherpa-onnx-tts/SKILL.md +109 -0
- package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
- package/skills/skill-creator/SKILL.md +78 -0
- package/skills/skill-creator/license.txt +202 -0
- package/skills/skill-creator/scripts/init_skill.py +378 -0
- package/skills/skill-creator/scripts/package_skill.py +139 -0
- package/skills/skill-creator/scripts/quick_validate.py +169 -0
- package/skills/skill-creator/scripts/test_package_skill.py +161 -0
- package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
- package/skills/slack/SKILL.md +78 -0
- package/skills/songsee/SKILL.md +49 -0
- package/skills/sonoscli/SKILL.md +65 -0
- package/skills/spike/SKILL.md +51 -0
- package/skills/spotify-player/SKILL.md +64 -0
- package/skills/summarize/SKILL.md +87 -0
- package/skills/taskflow/SKILL.md +149 -0
- package/skills/taskflow/examples/inbox-triage.lobster +33 -0
- package/skills/taskflow/examples/pr-intake.lobster +32 -0
- package/skills/taskflow-inbox-triage/SKILL.md +119 -0
- package/skills/things-mac/SKILL.md +86 -0
- package/skills/tmux/SKILL.md +91 -0
- package/skills/tmux/scripts/find-sessions.sh +112 -0
- package/skills/tmux/scripts/wait-for-text.sh +83 -0
- package/skills/trello/SKILL.md +108 -0
- package/skills/video-frames/SKILL.md +46 -0
- package/skills/video-frames/scripts/frame.sh +81 -0
- package/skills/voice-call/SKILL.md +45 -0
- package/skills/wacli/SKILL.md +72 -0
- package/skills/weather/SKILL.md +64 -0
- package/skills/xurl/SKILL.md +120 -0
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `nodmix 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
|
+
# `nodmix uninstall`
|
|
10
|
+
|
|
11
|
+
Uninstall the gateway service + local data (CLI remains).
|
|
12
|
+
|
|
13
|
+
Options:
|
|
14
|
+
|
|
15
|
+
- `--service`: remove the gateway service
|
|
16
|
+
- `--state`: remove state and config
|
|
17
|
+
- `--workspace`: remove workspace directories
|
|
18
|
+
- `--app`: remove the macOS app
|
|
19
|
+
- `--all`: remove service, state, workspace, and app
|
|
20
|
+
- `--yes`: skip confirmation prompts
|
|
21
|
+
- `--non-interactive`: disable prompts; requires `--yes`
|
|
22
|
+
- `--dry-run`: print actions without removing files
|
|
23
|
+
|
|
24
|
+
Examples:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
nodmix backup create
|
|
28
|
+
nodmix uninstall
|
|
29
|
+
nodmix uninstall --service --yes --non-interactive
|
|
30
|
+
nodmix uninstall --state --workspace --yes --non-interactive
|
|
31
|
+
nodmix uninstall --all --yes
|
|
32
|
+
nodmix uninstall --dry-run
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Notes:
|
|
36
|
+
|
|
37
|
+
- Run `nodmix backup create` first if you want a restorable snapshot before removing state or workspaces.
|
|
38
|
+
- `--all` is shorthand for removing service, state, workspace, and app together.
|
|
39
|
+
- `--non-interactive` requires `--yes`.
|
|
40
|
+
|
|
41
|
+
## Related
|
|
42
|
+
|
|
43
|
+
- [CLI reference](/cli)
|
|
44
|
+
- [Uninstall](/install/uninstall)
|
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `nodmix update` (safe-ish source update + gateway auto-restart)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to update a source checkout safely
|
|
5
|
+
- You are debugging `nodmix update` output or options
|
|
6
|
+
- You need to understand `--update` shorthand behavior
|
|
7
|
+
title: "Update"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# `nodmix update`
|
|
11
|
+
|
|
12
|
+
Safely update Nodmix and switch between stable/beta/dev channels.
|
|
13
|
+
|
|
14
|
+
If you installed via **npm/pnpm/bun** (global install, no git metadata),
|
|
15
|
+
updates happen via the package-manager flow in [Updating](/install/updating).
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
nodmix update
|
|
21
|
+
nodmix update status
|
|
22
|
+
nodmix update wizard
|
|
23
|
+
nodmix update --channel beta
|
|
24
|
+
nodmix update --channel dev
|
|
25
|
+
nodmix update --tag beta
|
|
26
|
+
nodmix update --tag main
|
|
27
|
+
nodmix update --dry-run
|
|
28
|
+
nodmix update --no-restart
|
|
29
|
+
nodmix update --yes
|
|
30
|
+
nodmix update --json
|
|
31
|
+
nodmix --update
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Options
|
|
35
|
+
|
|
36
|
+
- `--no-restart`: skip restarting the Gateway service after a successful update. Package-manager updates that do restart the Gateway verify the restarted service reports the expected updated version before the command succeeds.
|
|
37
|
+
- `--channel <stable|beta|dev>`: set the update channel (git + npm; persisted in config).
|
|
38
|
+
- `--tag <dist-tag|version|spec>`: override the package target for this update only. For package installs, `main` maps to `github:nodmix/nodmix#main`.
|
|
39
|
+
- `--dry-run`: preview planned update actions (channel/tag/target/restart flow) without writing config, installing, syncing plugins, or restarting.
|
|
40
|
+
- `--json`: print machine-readable `UpdateRunResult` JSON, including
|
|
41
|
+
`postUpdate.plugins.warnings` when corrupt or unloadable managed plugins need
|
|
42
|
+
repair after the core update succeeds, beta-channel plugin fallback details
|
|
43
|
+
when a plugin has no beta release, and `postUpdate.plugins.integrityDrifts`
|
|
44
|
+
when npm plugin artifact drift is detected during post-update plugin sync.
|
|
45
|
+
- `--timeout <seconds>`: per-step timeout (default is 1800s).
|
|
46
|
+
- `--yes`: skip confirmation prompts (for example downgrade confirmation).
|
|
47
|
+
|
|
48
|
+
`nodmix update` does not have a `--verbose` flag. Use `--dry-run` to preview
|
|
49
|
+
the planned channel/tag/install/restart actions, `--json` for machine-readable
|
|
50
|
+
results, and `nodmix update status --json` when you only need channel and
|
|
51
|
+
availability details. If you are debugging Gateway logs around an update,
|
|
52
|
+
console verbosity and file log level are separate: Gateway `--verbose` affects
|
|
53
|
+
terminal/WebSocket output, while file logs require `logging.level: "debug"` or
|
|
54
|
+
`"trace"` in config. See [Gateway logging](/gateway/logging).
|
|
55
|
+
|
|
56
|
+
<Note>
|
|
57
|
+
In Nix mode (`NODMIX_NIX_MODE=1`), mutating `nodmix update` runs are disabled. Update the Nix source or flake input for this install instead; for nix-nodmix, use the agent-first [Quick Start](https://github.com/nodmix/nix-nodmix#quick-start). `nodmix update status` and `nodmix update --dry-run` remain read-only.
|
|
58
|
+
</Note>
|
|
59
|
+
|
|
60
|
+
<Warning>
|
|
61
|
+
Downgrades require confirmation because older versions can break configuration.
|
|
62
|
+
</Warning>
|
|
63
|
+
|
|
64
|
+
## `update status`
|
|
65
|
+
|
|
66
|
+
Show the active update channel + git tag/branch/SHA (for source checkouts), plus update availability.
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
nodmix update status
|
|
70
|
+
nodmix update status --json
|
|
71
|
+
nodmix update status --timeout 10
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Options:
|
|
75
|
+
|
|
76
|
+
- `--json`: print machine-readable status JSON.
|
|
77
|
+
- `--timeout <seconds>`: timeout for checks (default is 3s).
|
|
78
|
+
|
|
79
|
+
## `update wizard`
|
|
80
|
+
|
|
81
|
+
Interactive flow to pick an update channel and confirm whether to restart the Gateway
|
|
82
|
+
after updating (default is to restart). If you select `dev` without a git checkout, it
|
|
83
|
+
offers to create one.
|
|
84
|
+
|
|
85
|
+
Options:
|
|
86
|
+
|
|
87
|
+
- `--timeout <seconds>`: timeout for each update step (default `1800`)
|
|
88
|
+
|
|
89
|
+
## What it does
|
|
90
|
+
|
|
91
|
+
When you switch channels explicitly (`--channel ...`), Nodmix also keeps the
|
|
92
|
+
install method aligned:
|
|
93
|
+
|
|
94
|
+
- `dev` → ensures a git checkout (default: `~/nodmix`, override with `NODMIX_GIT_DIR`),
|
|
95
|
+
updates it, and installs the global CLI from that checkout.
|
|
96
|
+
- `stable` → installs from npm using `latest`.
|
|
97
|
+
- `beta` → prefers npm dist-tag `beta`, but falls back to `latest` when beta is
|
|
98
|
+
missing or older than the current stable release.
|
|
99
|
+
|
|
100
|
+
The Gateway core auto-updater (when enabled via config) launches the CLI update path
|
|
101
|
+
outside the live Gateway request handler. Control-plane `update.run` package-manager
|
|
102
|
+
updates also use a managed-service handoff instead of replacing the package tree
|
|
103
|
+
inside the live Gateway process. The Gateway starts a detached helper, exits,
|
|
104
|
+
and the helper runs the normal `nodmix update --yes --json` CLI path from
|
|
105
|
+
outside the Gateway process tree. If that handoff is unavailable, `update.run`
|
|
106
|
+
returns a structured response with the safe shell command to run manually.
|
|
107
|
+
|
|
108
|
+
For package-manager installs, `nodmix update` resolves the target package
|
|
109
|
+
version before invoking the package manager. npm global installs use a staged
|
|
110
|
+
install: Nodmix installs the new package into a temporary npm prefix, verifies
|
|
111
|
+
the packaged `dist` inventory there, then swaps that clean package tree into the
|
|
112
|
+
real global prefix. If verification fails, post-update doctor, plugin sync, and
|
|
113
|
+
restart work do not run from the suspect tree. Even when the installed version
|
|
114
|
+
already matches the target, the command refreshes the global package install,
|
|
115
|
+
then runs plugin sync, a core-command completion refresh, and restart work. This
|
|
116
|
+
keeps packaged sidecars and channel-owned plugin records aligned with the
|
|
117
|
+
installed Nodmix build while leaving full plugin-command completion rebuilds to
|
|
118
|
+
explicit `nodmix completion --write-state` runs.
|
|
119
|
+
|
|
120
|
+
When a local managed Gateway service is installed and restart is enabled,
|
|
121
|
+
package-manager updates stop the running service before replacing the package
|
|
122
|
+
tree, then refresh the service metadata from the updated install, restart the
|
|
123
|
+
service, and verify the restarted Gateway reports the expected version before
|
|
124
|
+
reporting `Gateway: restarted and verified.`. On macOS, the post-update check
|
|
125
|
+
also verifies the LaunchAgent is loaded/running for the active profile and the
|
|
126
|
+
configured loopback port is healthy. If the plist is installed but launchd is
|
|
127
|
+
not supervising it, Nodmix re-bootstraps the LaunchAgent automatically, then
|
|
128
|
+
reruns the health/version/channel readiness checks. A fresh bootstrap loads the
|
|
129
|
+
RunAtLoad job directly, so update recovery does not immediately `kickstart -k`
|
|
130
|
+
the newly spawned Gateway. If the Gateway still does not become healthy, the
|
|
131
|
+
command exits non-zero and prints the restart log path plus explicit restart,
|
|
132
|
+
reinstall, and package rollback instructions. If restart cannot run, the command
|
|
133
|
+
prints `Gateway: restart skipped (...)` or `Gateway: restart failed: ...` with a
|
|
134
|
+
manual `nodmix gateway restart` hint. With `--no-restart`,
|
|
135
|
+
package replacement still runs but the managed service is not stopped or
|
|
136
|
+
restarted, so the running Gateway may keep old code until you restart it
|
|
137
|
+
manually.
|
|
138
|
+
|
|
139
|
+
### Control-plane response shape
|
|
140
|
+
|
|
141
|
+
When `update.run` is invoked through the Gateway control plane on a
|
|
142
|
+
package-manager install, the handler reports the handoff initiation separately
|
|
143
|
+
from the CLI update that continues after the Gateway exits:
|
|
144
|
+
|
|
145
|
+
- `ok: true`, `result.status: "skipped"`,
|
|
146
|
+
`result.reason: "managed-service-handoff-started"`, and
|
|
147
|
+
`handoff.status: "started"` mean the Gateway created the managed-service
|
|
148
|
+
handoff and scheduled its own restart so the detached helper can run
|
|
149
|
+
`nodmix update --yes --json` outside the live service process.
|
|
150
|
+
- `ok: false`, `result.reason: "managed-service-handoff-unavailable"`, and
|
|
151
|
+
`handoff.status: "unavailable"` mean Nodmix could not find a supervising
|
|
152
|
+
service boundary for a safe handoff. The response includes
|
|
153
|
+
`handoff.command`, the shell command to run from outside the Gateway.
|
|
154
|
+
- `ok: false`, `result.reason: "managed-service-handoff-failed"` means the
|
|
155
|
+
Gateway tried to create the handoff but could not spawn the detached helper.
|
|
156
|
+
|
|
157
|
+
The `sentinel` payload is still written before the Gateway exits, and the CLI
|
|
158
|
+
handoff updates the same restart sentinel after the managed-service restart
|
|
159
|
+
health checks complete. During the handoff, the sentinel can carry
|
|
160
|
+
`stats.reason: "restart-health-pending"` with no success continuation; the
|
|
161
|
+
restarted Gateway keeps polling it and only fires the continuation after the CLI
|
|
162
|
+
has verified service health and rewritten the sentinel with the final `ok`
|
|
163
|
+
result. `nodmix status` and `nodmix status --all` show an `Update restart`
|
|
164
|
+
row while that sentinel is pending or failed, and `update.status` returns the
|
|
165
|
+
latest cached sentinel.
|
|
166
|
+
|
|
167
|
+
## Git checkout flow
|
|
168
|
+
|
|
169
|
+
### Channel selection
|
|
170
|
+
|
|
171
|
+
- `stable`: checkout the latest non-beta tag, then build and doctor.
|
|
172
|
+
- `beta`: prefer the latest `-beta` tag, but fall back to the latest stable tag when beta is missing or older.
|
|
173
|
+
- `dev`: checkout `main`, then fetch and rebase.
|
|
174
|
+
|
|
175
|
+
### Update steps
|
|
176
|
+
|
|
177
|
+
<Steps>
|
|
178
|
+
<Step title="Verify clean worktree">
|
|
179
|
+
Requires no uncommitted changes.
|
|
180
|
+
</Step>
|
|
181
|
+
<Step title="Switch channel">
|
|
182
|
+
Switches to the selected channel (tag or branch).
|
|
183
|
+
</Step>
|
|
184
|
+
<Step title="Fetch upstream">
|
|
185
|
+
Dev only.
|
|
186
|
+
</Step>
|
|
187
|
+
<Step title="Preflight build (dev only)">
|
|
188
|
+
Runs the TypeScript build in a temp worktree. If the tip fails, walks back up to 10 commits to find the newest buildable commit. Set `NODMIX_UPDATE_PREFLIGHT_LINT=1` to also run lint during this preflight; lint runs in constrained serial mode because user update hosts are often smaller than CI runners.
|
|
189
|
+
</Step>
|
|
190
|
+
<Step title="Rebase">
|
|
191
|
+
Rebases onto the selected commit (dev only).
|
|
192
|
+
</Step>
|
|
193
|
+
<Step title="Install dependencies">
|
|
194
|
+
Uses the repo package manager. For pnpm checkouts, the updater bootstraps `pnpm` on demand (via `corepack` first, then a temporary `npm install pnpm@11` fallback) instead of running `npm run build` inside a pnpm workspace.
|
|
195
|
+
</Step>
|
|
196
|
+
<Step title="Build Control UI">
|
|
197
|
+
Builds the gateway and the Control UI.
|
|
198
|
+
</Step>
|
|
199
|
+
<Step title="Run doctor">
|
|
200
|
+
`nodmix doctor` runs as the final safe-update check.
|
|
201
|
+
</Step>
|
|
202
|
+
<Step title="Sync plugins">
|
|
203
|
+
Syncs plugins to the active channel. Dev uses bundled plugins; stable and beta use npm. Updates tracked plugin installs.
|
|
204
|
+
</Step>
|
|
205
|
+
</Steps>
|
|
206
|
+
|
|
207
|
+
On the beta update channel, tracked npm and ClawHub plugin installs that follow
|
|
208
|
+
the default/latest line try a plugin `@beta` release first. If the plugin has no
|
|
209
|
+
beta release, Nodmix falls back to the recorded default/latest spec and reports
|
|
210
|
+
that as a warning. For npm plugins, Nodmix also falls back when the beta
|
|
211
|
+
package exists but fails install validation. These plugin fallback warnings do
|
|
212
|
+
not make the core update fail. Exact versions and explicit tags are not
|
|
213
|
+
rewritten.
|
|
214
|
+
|
|
215
|
+
<Warning>
|
|
216
|
+
If an exact pinned npm plugin update resolves to an artifact whose integrity differs from the stored install record, `nodmix update` aborts that plugin artifact update instead of installing it. Reinstall or update the plugin explicitly only after verifying that you trust the new artifact.
|
|
217
|
+
</Warning>
|
|
218
|
+
|
|
219
|
+
<Note>
|
|
220
|
+
Post-update plugin sync failures that are scoped to a managed plugin and that the sync path can route around (e.g. an unreachable npm registry for a non-essential plugin) are reported as warnings after the core update succeeds. The JSON result keeps the top-level update `status: "ok"` and reports `postUpdate.plugins.status: "warning"` with `nodmix doctor --fix` and `nodmix plugins inspect <id> --runtime --json` guidance. Unexpected updater or sync exceptions still fail the update result. Fix the plugin install or update error, then rerun `nodmix doctor --fix` or `nodmix update`.
|
|
221
|
+
|
|
222
|
+
After the per-plugin sync step, `nodmix update` runs a mandatory **post-core convergence** pass before the gateway is restarted: it repairs missing configured plugin payloads, validates each _active_ tracked install record on disk, and statically verifies its `package.json` is parseable (and any explicitly-declared `main` exists). Failures from this pass — and an invalid Nodmix config snapshot — return `postUpdate.plugins.status: "error"` and flip the top-level update `status` to `"error"`, so `nodmix update` exits non-zero and the gateway is _not_ restarted with an unverified plugin set. The error includes structured `postUpdate.plugins.warnings[].guidance` lines pointing at `nodmix doctor --fix` and `nodmix plugins inspect <id> --runtime --json` for follow-up. Disabled plugin entries and records that are not trusted-source-linked official sync targets are skipped here, mirroring the `skipDisabledPlugins` policy used by the missing-payload check, so a stale disabled plugin record cannot block an otherwise valid update.
|
|
223
|
+
|
|
224
|
+
When the updated Gateway starts, plugin loading is verify-only: startup does not
|
|
225
|
+
run package managers or mutate dependency trees. Package-manager `update.run`
|
|
226
|
+
restarts are handed to the CLI managed-service path, so the package swap happens
|
|
227
|
+
outside the old Gateway process and the service health checks decide whether the
|
|
228
|
+
update can be reported as complete.
|
|
229
|
+
|
|
230
|
+
If pnpm bootstrap still fails, the updater stops early with a package-manager-specific error instead of trying `npm run build` inside the checkout.
|
|
231
|
+
</Note>
|
|
232
|
+
|
|
233
|
+
## `--update` shorthand
|
|
234
|
+
|
|
235
|
+
`nodmix --update` rewrites to `nodmix update` (useful for shells and launcher scripts).
|
|
236
|
+
|
|
237
|
+
## Related
|
|
238
|
+
|
|
239
|
+
- `nodmix doctor` (offers to run update first on git checkouts)
|
|
240
|
+
- [Development channels](/install/development-channels)
|
|
241
|
+
- [Updating](/install/updating)
|
|
242
|
+
- [CLI reference](/cli)
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `nodmix voicecall` (voice-call plugin command surface)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You use the voice-call plugin and want every CLI entry point
|
|
5
|
+
- You need flag tables and defaults for setup, smoke, call, continue, speak, dtmf, end, status, tail, latency, expose, and start
|
|
6
|
+
title: "Voicecall"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `nodmix voicecall`
|
|
10
|
+
|
|
11
|
+
`voicecall` is a plugin-provided command. It only appears when the voice-call plugin is installed and enabled.
|
|
12
|
+
|
|
13
|
+
When the Gateway is running, operational commands (`call`, `start`, `continue`, `speak`, `dtmf`, `end`, `status`) are routed to that Gateway's voice-call runtime. If no Gateway is reachable, they fall back to a standalone CLI runtime.
|
|
14
|
+
|
|
15
|
+
## Subcommands
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
nodmix voicecall setup [--json]
|
|
19
|
+
nodmix voicecall smoke [-t <phone>] [--message <text>] [--mode <m>] [--yes] [--json]
|
|
20
|
+
nodmix voicecall call -m <text> [-t <phone>] [--mode <m>]
|
|
21
|
+
nodmix voicecall start --to <phone> [--message <text>] [--mode <m>]
|
|
22
|
+
nodmix voicecall continue --call-id <id> --message <text>
|
|
23
|
+
nodmix voicecall speak --call-id <id> --message <text>
|
|
24
|
+
nodmix voicecall dtmf --call-id <id> --digits <digits>
|
|
25
|
+
nodmix voicecall end --call-id <id>
|
|
26
|
+
nodmix voicecall status [--call-id <id>] [--json]
|
|
27
|
+
nodmix voicecall tail [--file <path>] [--since <n>] [--poll <ms>]
|
|
28
|
+
nodmix voicecall latency [--file <path>] [--last <n>]
|
|
29
|
+
nodmix voicecall expose [--mode <m>] [--path <p>] [--port <port>] [--serve-path <p>]
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
| Subcommand | Description |
|
|
33
|
+
| ---------- | --------------------------------------------------------------- |
|
|
34
|
+
| `setup` | Show provider and webhook readiness checks. |
|
|
35
|
+
| `smoke` | Run readiness checks; place a live test call only with `--yes`. |
|
|
36
|
+
| `call` | Initiate an outbound voice call. |
|
|
37
|
+
| `start` | Alias for `call` with `--to` required and `--message` optional. |
|
|
38
|
+
| `continue` | Speak a message and wait for the next response. |
|
|
39
|
+
| `speak` | Speak a message without waiting for a response. |
|
|
40
|
+
| `dtmf` | Send DTMF digits to an active call. |
|
|
41
|
+
| `end` | Hang up an active call. |
|
|
42
|
+
| `status` | Inspect active calls (or one by `--call-id`). |
|
|
43
|
+
| `tail` | Tail `calls.jsonl` (useful during provider tests). |
|
|
44
|
+
| `latency` | Summarize turn-latency metrics from `calls.jsonl`. |
|
|
45
|
+
| `expose` | Toggle Tailscale serve/funnel for the webhook endpoint. |
|
|
46
|
+
|
|
47
|
+
## Setup and smoke
|
|
48
|
+
|
|
49
|
+
### `setup`
|
|
50
|
+
|
|
51
|
+
Prints human-readable readiness checks by default. Pass `--json` for scripts.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
nodmix voicecall setup
|
|
55
|
+
nodmix voicecall setup --json
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### `smoke`
|
|
59
|
+
|
|
60
|
+
Runs the same readiness checks. It will not place a real phone call unless both `--to` and `--yes` are present.
|
|
61
|
+
|
|
62
|
+
| Flag | Default | Description |
|
|
63
|
+
| ------------------ | --------------------------------- | --------------------------------------- |
|
|
64
|
+
| `-t, --to <phone>` | (none) | Phone number to call for a live smoke. |
|
|
65
|
+
| `--message <text>` | `Nodmix voice call smoke test.` | Message to speak during the smoke call. |
|
|
66
|
+
| `--mode <mode>` | `notify` | Call mode: `notify` or `conversation`. |
|
|
67
|
+
| `--yes` | `false` | Actually place the live outbound call. |
|
|
68
|
+
| `--json` | `false` | Print machine-readable JSON. |
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
nodmix voicecall smoke
|
|
72
|
+
nodmix voicecall smoke --to "+15555550123" # dry run
|
|
73
|
+
nodmix voicecall smoke --to "+15555550123" --yes # live notify call
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
<Note>
|
|
77
|
+
For external providers (`twilio`, `telnyx`, `plivo`), `setup` and `smoke` require a public webhook URL from `publicUrl`, a tunnel, or Tailscale exposure. A loopback or private serve fallback is rejected because carriers cannot reach it.
|
|
78
|
+
</Note>
|
|
79
|
+
|
|
80
|
+
## Call lifecycle
|
|
81
|
+
|
|
82
|
+
### `call`
|
|
83
|
+
|
|
84
|
+
Initiate an outbound voice call.
|
|
85
|
+
|
|
86
|
+
| Flag | Required | Default | Description |
|
|
87
|
+
| ---------------------- | -------- | ----------------- | -------------------------------------------------------------------------- |
|
|
88
|
+
| `-m, --message <text>` | yes | (none) | Message to speak when the call connects. |
|
|
89
|
+
| `-t, --to <phone>` | no | config `toNumber` | E.164 phone number to call. |
|
|
90
|
+
| `--mode <mode>` | no | `conversation` | Call mode: `notify` (hang up after message) or `conversation` (stay open). |
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
nodmix voicecall call --to "+15555550123" --message "Hello"
|
|
94
|
+
nodmix voicecall call -m "Heads up" --mode notify
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### `start`
|
|
98
|
+
|
|
99
|
+
Alias for `call` with a different default flag shape.
|
|
100
|
+
|
|
101
|
+
| Flag | Required | Default | Description |
|
|
102
|
+
| ------------------ | -------- | -------------- | ---------------------------------------- |
|
|
103
|
+
| `--to <phone>` | yes | (none) | Phone number to call. |
|
|
104
|
+
| `--message <text>` | no | (none) | Message to speak when the call connects. |
|
|
105
|
+
| `--mode <mode>` | no | `conversation` | Call mode: `notify` or `conversation`. |
|
|
106
|
+
|
|
107
|
+
### `continue`
|
|
108
|
+
|
|
109
|
+
Speak a message and wait for a response.
|
|
110
|
+
|
|
111
|
+
| Flag | Required | Description |
|
|
112
|
+
| ------------------ | -------- | ----------------- |
|
|
113
|
+
| `--call-id <id>` | yes | Call ID. |
|
|
114
|
+
| `--message <text>` | yes | Message to speak. |
|
|
115
|
+
|
|
116
|
+
### `speak`
|
|
117
|
+
|
|
118
|
+
Speak a message without waiting for a response.
|
|
119
|
+
|
|
120
|
+
| Flag | Required | Description |
|
|
121
|
+
| ------------------ | -------- | ----------------- |
|
|
122
|
+
| `--call-id <id>` | yes | Call ID. |
|
|
123
|
+
| `--message <text>` | yes | Message to speak. |
|
|
124
|
+
|
|
125
|
+
### `dtmf`
|
|
126
|
+
|
|
127
|
+
Send DTMF digits to an active call.
|
|
128
|
+
|
|
129
|
+
| Flag | Required | Description |
|
|
130
|
+
| ------------------- | -------- | ----------------------------------------- |
|
|
131
|
+
| `--call-id <id>` | yes | Call ID. |
|
|
132
|
+
| `--digits <digits>` | yes | DTMF digits (e.g. `ww123456#` for waits). |
|
|
133
|
+
|
|
134
|
+
### `end`
|
|
135
|
+
|
|
136
|
+
Hang up an active call.
|
|
137
|
+
|
|
138
|
+
| Flag | Required | Description |
|
|
139
|
+
| ---------------- | -------- | ----------- |
|
|
140
|
+
| `--call-id <id>` | yes | Call ID. |
|
|
141
|
+
|
|
142
|
+
### `status`
|
|
143
|
+
|
|
144
|
+
Inspect active calls.
|
|
145
|
+
|
|
146
|
+
| Flag | Default | Description |
|
|
147
|
+
| ---------------- | ------- | ---------------------------- |
|
|
148
|
+
| `--call-id <id>` | (none) | Restrict output to one call. |
|
|
149
|
+
| `--json` | `false` | Print machine-readable JSON. |
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
nodmix voicecall status
|
|
153
|
+
nodmix voicecall status --json
|
|
154
|
+
nodmix voicecall status --call-id <id>
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Logs and metrics
|
|
158
|
+
|
|
159
|
+
### `tail`
|
|
160
|
+
|
|
161
|
+
Tail the voice-call JSONL log. Prints the last `--since` lines on start, then streams new lines as they are written.
|
|
162
|
+
|
|
163
|
+
| Flag | Default | Description |
|
|
164
|
+
| --------------- | -------------------------- | ------------------------------ |
|
|
165
|
+
| `--file <path>` | resolved from plugin store | Path to `calls.jsonl`. |
|
|
166
|
+
| `--since <n>` | `25` | Lines to print before tailing. |
|
|
167
|
+
| `--poll <ms>` | `250` (minimum 50) | Poll interval in milliseconds. |
|
|
168
|
+
|
|
169
|
+
### `latency`
|
|
170
|
+
|
|
171
|
+
Summarize turn-latency and listen-wait metrics from `calls.jsonl`. Output is JSON with `recordsScanned`, `turnLatency`, and `listenWait` summaries.
|
|
172
|
+
|
|
173
|
+
| Flag | Default | Description |
|
|
174
|
+
| --------------- | -------------------------- | ------------------------------------ |
|
|
175
|
+
| `--file <path>` | resolved from plugin store | Path to `calls.jsonl`. |
|
|
176
|
+
| `--last <n>` | `200` (minimum 1) | Number of recent records to analyze. |
|
|
177
|
+
|
|
178
|
+
## Exposing webhooks
|
|
179
|
+
|
|
180
|
+
### `expose`
|
|
181
|
+
|
|
182
|
+
Enable, disable, or change the Tailscale serve/funnel configuration for the voice webhook.
|
|
183
|
+
|
|
184
|
+
| Flag | Default | Description |
|
|
185
|
+
| --------------------- | ----------------------------------------- | ----------------------------------------------- |
|
|
186
|
+
| `--mode <mode>` | `funnel` | `off`, `serve` (tailnet), or `funnel` (public). |
|
|
187
|
+
| `--path <path>` | config `tailscale.path` or `--serve-path` | Tailscale path to expose. |
|
|
188
|
+
| `--port <port>` | config `serve.port` or `3334` | Local webhook port. |
|
|
189
|
+
| `--serve-path <path>` | config `serve.path` or `/voice/webhook` | Local webhook path. |
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
nodmix voicecall expose --mode serve
|
|
193
|
+
nodmix voicecall expose --mode funnel
|
|
194
|
+
nodmix voicecall expose --mode off
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
<Warning>
|
|
198
|
+
Only expose the webhook endpoint to networks you trust. Prefer Tailscale Serve over Funnel when possible.
|
|
199
|
+
</Warning>
|
|
200
|
+
|
|
201
|
+
## Related
|
|
202
|
+
|
|
203
|
+
- [CLI reference](/cli)
|
|
204
|
+
- [Voice call plugin](/plugins/voice-call)
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `nodmix webhooks` (Gmail Pub/Sub setup and runner)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to wire Gmail Pub/Sub events into Nodmix
|
|
5
|
+
- You need the full flag list and default values
|
|
6
|
+
title: "Webhooks"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `nodmix webhooks`
|
|
10
|
+
|
|
11
|
+
Webhook helpers and integrations. Today this surface is scoped to Gmail Pub/Sub flows that integrate with the bundled `gog` watcher.
|
|
12
|
+
|
|
13
|
+
## Subcommands
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
nodmix webhooks gmail setup --account <email> [...]
|
|
17
|
+
nodmix webhooks gmail run [--account <email>] [...]
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
| Subcommand | Description |
|
|
21
|
+
| ------------- | -------------------------------------------------------------------------------------------- |
|
|
22
|
+
| `gmail setup` | Configure Gmail watch, Pub/Sub topic/subscription, and the Nodmix webhook delivery target. |
|
|
23
|
+
| `gmail run` | Run `gog watch serve` plus the watch auto-renew loop. |
|
|
24
|
+
|
|
25
|
+
## `webhooks gmail setup`
|
|
26
|
+
|
|
27
|
+
Configure Gmail watch, Pub/Sub, and Nodmix webhook delivery.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
nodmix webhooks gmail setup --account you@example.com
|
|
31
|
+
nodmix webhooks gmail setup --account you@example.com --project my-gcp-project --json
|
|
32
|
+
nodmix webhooks gmail setup --account you@example.com --hook-url https://gateway.example.com/hooks/gmail
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Required
|
|
36
|
+
|
|
37
|
+
| Flag | Description |
|
|
38
|
+
| ------------------- | ----------------------- |
|
|
39
|
+
| `--account <email>` | Gmail account to watch. |
|
|
40
|
+
|
|
41
|
+
### Pub/Sub options
|
|
42
|
+
|
|
43
|
+
| Flag | Default | Description |
|
|
44
|
+
| ----------------------- | ---------------------- | ---------------------------------------------------- |
|
|
45
|
+
| `--project <id>` | (none) | GCP project id (the OAuth client owner). |
|
|
46
|
+
| `--topic <name>` | `gog-gmail-watch` | Pub/Sub topic name. |
|
|
47
|
+
| `--subscription <name>` | `gog-gmail-watch-push` | Pub/Sub subscription name. |
|
|
48
|
+
| `--label <label>` | `INBOX` | Gmail label to watch. |
|
|
49
|
+
| `--push-endpoint <url>` | (none) | Explicit Pub/Sub push endpoint. Overrides Tailscale. |
|
|
50
|
+
|
|
51
|
+
### Nodmix delivery options
|
|
52
|
+
|
|
53
|
+
| Flag | Default | Description |
|
|
54
|
+
| ---------------------- | ------- | ------------------------------------------ |
|
|
55
|
+
| `--hook-url <url>` | (none) | Nodmix webhook URL. |
|
|
56
|
+
| `--hook-token <token>` | (none) | Nodmix webhook token. |
|
|
57
|
+
| `--push-token <token>` | (none) | Push token forwarded to `gog watch serve`. |
|
|
58
|
+
|
|
59
|
+
### `gog watch serve` options
|
|
60
|
+
|
|
61
|
+
| Flag | Default | Description |
|
|
62
|
+
| --------------------- | --------------- | ----------------------------------------------------------------- |
|
|
63
|
+
| `--bind <host>` | `127.0.0.1` | `gog watch serve` bind host. |
|
|
64
|
+
| `--port <port>` | `8788` | `gog watch serve` port. |
|
|
65
|
+
| `--path <path>` | `/gmail-pubsub` | `gog watch serve` path. |
|
|
66
|
+
| `--include-body` | `true` | Include email body snippets. Pass `--no-include-body` to disable. |
|
|
67
|
+
| `--max-bytes <n>` | `20000` | Max bytes per body snippet. |
|
|
68
|
+
| `--renew-minutes <n>` | `720` (12h) | Renew Gmail watch every N minutes. |
|
|
69
|
+
|
|
70
|
+
### Tailscale exposure
|
|
71
|
+
|
|
72
|
+
| Flag | Default | Description |
|
|
73
|
+
| ------------------------- | -------- | ---------------------------------------------------------------- |
|
|
74
|
+
| `--tailscale <mode>` | `funnel` | Expose push endpoint via tailscale: `funnel`, `serve`, or `off`. |
|
|
75
|
+
| `--tailscale-path <path>` | (none) | Path for tailscale serve/funnel. |
|
|
76
|
+
| `--tailscale-target <t>` | (none) | Tailscale serve/funnel target (port, `host:port`, or URL). |
|
|
77
|
+
|
|
78
|
+
### Output
|
|
79
|
+
|
|
80
|
+
| Flag | Description |
|
|
81
|
+
| -------- | ------------------------------------------------- |
|
|
82
|
+
| `--json` | Print a machine-readable summary instead of text. |
|
|
83
|
+
|
|
84
|
+
## `webhooks gmail run`
|
|
85
|
+
|
|
86
|
+
Run `gog watch serve` plus the watch auto-renew loop in the foreground.
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
nodmix webhooks gmail run --account you@example.com
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
`run` accepts the same `gog watch serve`, Nodmix delivery, Pub/Sub, and Tailscale flags as `setup`, except:
|
|
93
|
+
|
|
94
|
+
- `--account` is **optional** on `run` (it falls back to the configured account).
|
|
95
|
+
- `run` does **not** accept `--project`, `--push-endpoint`, or `--json`.
|
|
96
|
+
- `run` flags have no built-in defaults; missing values fall back to the values written by `setup`.
|
|
97
|
+
|
|
98
|
+
| Category | Flags |
|
|
99
|
+
| ----------------- | -------------------------------------------------------------------------------- |
|
|
100
|
+
| Pub/Sub | `--account`, `--topic`, `--subscription`, `--label` |
|
|
101
|
+
| Nodmix delivery | `--hook-url`, `--hook-token`, `--push-token` |
|
|
102
|
+
| `gog watch serve` | `--bind`, `--port`, `--path`, `--include-body`, `--max-bytes`, `--renew-minutes` |
|
|
103
|
+
| Tailscale | `--tailscale`, `--tailscale-path`, `--tailscale-target` |
|
|
104
|
+
|
|
105
|
+
<Note>
|
|
106
|
+
For `run`, the `--topic` value is the full Pub/Sub topic path (`projects/.../topics/...`), not just the short topic name.
|
|
107
|
+
</Note>
|
|
108
|
+
|
|
109
|
+
## End-to-end flow
|
|
110
|
+
|
|
111
|
+
See [Gmail Pub/Sub integration](/automation/cron-jobs#gmail-pubsub-integration) for the GCP project, OAuth, and gateway-side setup that pairs with these CLI commands.
|
|
112
|
+
|
|
113
|
+
## Related
|
|
114
|
+
|
|
115
|
+
- [CLI reference](/cli)
|
|
116
|
+
- [Webhook automation](/automation/webhook)
|
|
117
|
+
- [Gmail Pub/Sub](/automation/cron-jobs#gmail-pubsub-integration)
|