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,112 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Setup guide for developers working on the Nodmix macOS app"
|
|
3
|
+
read_when:
|
|
4
|
+
- Setting up the macOS development environment
|
|
5
|
+
title: "macOS dev setup"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# macOS developer setup
|
|
9
|
+
|
|
10
|
+
Build and run the Nodmix macOS application from source.
|
|
11
|
+
|
|
12
|
+
## Prerequisites
|
|
13
|
+
|
|
14
|
+
Before building the app, ensure you have the following installed:
|
|
15
|
+
|
|
16
|
+
1. **Xcode 26.2+**: Required for Swift development.
|
|
17
|
+
2. **Node.js 24 & pnpm**: Recommended for the gateway, CLI, and packaging scripts. Node 22 LTS, currently `22.19+`, remains supported for compatibility.
|
|
18
|
+
|
|
19
|
+
## 1. Install Dependencies
|
|
20
|
+
|
|
21
|
+
Install the project-wide dependencies:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pnpm install
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 2. Build and Package the App
|
|
28
|
+
|
|
29
|
+
To build the macOS app and package it into `dist/Nodmix.app`, run:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
./scripts/package-mac-app.sh
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
If you don't have an Apple Developer ID certificate, the script will automatically use **ad-hoc signing** (`-`).
|
|
36
|
+
|
|
37
|
+
For dev run modes, signing flags, and Team ID troubleshooting, see the macOS app README:
|
|
38
|
+
[https://github.com/nodmix/nodmix/blob/main/apps/macos/README.md](https://github.com/nodmix/nodmix/blob/main/apps/macos/README.md)
|
|
39
|
+
|
|
40
|
+
> **Note**: Ad-hoc signed apps may trigger security prompts. If the app crashes immediately with "Abort trap 6", see the [Troubleshooting](#troubleshooting) section.
|
|
41
|
+
|
|
42
|
+
## 3. Install the CLI
|
|
43
|
+
|
|
44
|
+
The macOS app expects a global `nodmix` CLI install to manage background tasks.
|
|
45
|
+
|
|
46
|
+
**To install it (recommended):**
|
|
47
|
+
|
|
48
|
+
1. Open the Nodmix app.
|
|
49
|
+
2. Go to the **General** settings tab.
|
|
50
|
+
3. Click **"Install CLI"**.
|
|
51
|
+
|
|
52
|
+
Alternatively, install it manually:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
npm install -g nodmix@<version>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
`pnpm add -g nodmix@<version>` and `bun add -g nodmix@<version>` also work.
|
|
59
|
+
For the Gateway runtime, Node remains the recommended path.
|
|
60
|
+
|
|
61
|
+
## Troubleshooting
|
|
62
|
+
|
|
63
|
+
### Build fails: toolchain or SDK mismatch
|
|
64
|
+
|
|
65
|
+
The macOS app build expects the latest macOS SDK and Swift 6.2 toolchain.
|
|
66
|
+
|
|
67
|
+
**System dependencies (required):**
|
|
68
|
+
|
|
69
|
+
- **Latest macOS version available in Software Update** (required by Xcode 26.2 SDKs)
|
|
70
|
+
- **Xcode 26.2** (Swift 6.2 toolchain)
|
|
71
|
+
|
|
72
|
+
**Checks:**
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
xcodebuild -version
|
|
76
|
+
xcrun swift --version
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
If versions don't match, update macOS/Xcode and re-run the build.
|
|
80
|
+
|
|
81
|
+
### App crashes on permission grant
|
|
82
|
+
|
|
83
|
+
If the app crashes when you try to allow **Speech Recognition** or **Microphone** access, it may be due to a corrupted TCC cache or signature mismatch.
|
|
84
|
+
|
|
85
|
+
**Fix:**
|
|
86
|
+
|
|
87
|
+
1. Reset the TCC permissions:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
tccutil reset All ai.nodmix.mac.debug
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
2. If that fails, change the `BUNDLE_ID` temporarily in [`scripts/package-mac-app.sh`](https://github.com/nodmix/nodmix/blob/main/scripts/package-mac-app.sh) to force a "clean slate" from macOS.
|
|
94
|
+
|
|
95
|
+
### Gateway "Starting..." indefinitely
|
|
96
|
+
|
|
97
|
+
If the gateway status stays on "Starting...", check if a zombie process is holding the port:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
nodmix gateway status
|
|
101
|
+
nodmix gateway stop
|
|
102
|
+
|
|
103
|
+
# If you're not using a LaunchAgent (dev mode / manual runs), find the listener:
|
|
104
|
+
lsof -nP -iTCP:18789 -sTCP:LISTEN
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
If a manual run is holding the port, stop that process (Ctrl+C). As a last resort, kill the PID you found above.
|
|
108
|
+
|
|
109
|
+
## Related
|
|
110
|
+
|
|
111
|
+
- [macOS app](/platforms/macos)
|
|
112
|
+
- [Install overview](/install)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "How the macOS app reports gateway/Baileys health states"
|
|
3
|
+
read_when:
|
|
4
|
+
- Debugging mac app health indicators
|
|
5
|
+
title: "Health checks (macOS)"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Health Checks on macOS
|
|
9
|
+
|
|
10
|
+
How to see whether the linked channel is healthy from the menu bar app.
|
|
11
|
+
|
|
12
|
+
## Menu bar
|
|
13
|
+
|
|
14
|
+
- Status dot now reflects Baileys health:
|
|
15
|
+
- Green: linked + socket opened recently.
|
|
16
|
+
- Orange: connecting/retrying.
|
|
17
|
+
- Red: logged out or probe failed.
|
|
18
|
+
- Secondary line reads "linked · auth 12m" or shows the failure reason.
|
|
19
|
+
- "Run Health Check" menu item triggers an on-demand probe.
|
|
20
|
+
|
|
21
|
+
## Settings
|
|
22
|
+
|
|
23
|
+
- General tab gains a Health card showing: linked auth age, session-store path/count, last check time, last error/status code, and buttons for Run Health Check / Reveal Logs.
|
|
24
|
+
- Uses a cached snapshot so the UI loads instantly and falls back gracefully when offline.
|
|
25
|
+
- **Channels tab** surfaces channel status + controls for WhatsApp/Telegram (login QR, logout, probe, last disconnect/error).
|
|
26
|
+
|
|
27
|
+
## How the probe works
|
|
28
|
+
|
|
29
|
+
- App runs `nodmix health --json` via `ShellExecutor` every ~60s and on demand. The probe loads creds and reports status without sending messages.
|
|
30
|
+
- Cache the last good snapshot and the last error separately to avoid flicker; show the timestamp of each.
|
|
31
|
+
|
|
32
|
+
## When in doubt
|
|
33
|
+
|
|
34
|
+
- You can still use the CLI flow in [Gateway health](/gateway/health) (`nodmix status`, `nodmix status --deep`, `nodmix health --json`) and tail `/tmp/nodmix/nodmix-*.log` for `web-heartbeat` / `web-reconnect`.
|
|
35
|
+
|
|
36
|
+
## Related
|
|
37
|
+
|
|
38
|
+
- [Gateway health](/gateway/health)
|
|
39
|
+
- [macOS app](/platforms/macos)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Menu bar icon states and animations for Nodmix on macOS"
|
|
3
|
+
read_when:
|
|
4
|
+
- Changing menu bar icon behavior
|
|
5
|
+
title: "Menu bar icon"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Menu Bar Icon States
|
|
9
|
+
|
|
10
|
+
Author: steipete · Updated: 2025-12-06 · Scope: macOS app (`apps/macos`)
|
|
11
|
+
|
|
12
|
+
- **Idle:** Normal icon animation (blink, occasional wiggle).
|
|
13
|
+
- **Paused:** Status item uses `appearsDisabled`; no motion.
|
|
14
|
+
- **Voice trigger (big ears):** Voice wake detector calls `AppState.triggerVoiceEars(ttl: nil)` when the wake word is heard, keeping `earBoostActive=true` while the utterance is captured. Ears scale up (1.9x), get circular ear holes for readability, then drop via `stopVoiceEars()` after 1s of silence. Only fired from the in-app voice pipeline.
|
|
15
|
+
- **Working (agent running):** `AppState.isWorking=true` drives a "tail/leg scurry" micro-motion: faster leg wiggle and slight offset while work is in-flight. Currently toggled around WebChat agent runs; add the same toggle around other long tasks when you wire them.
|
|
16
|
+
|
|
17
|
+
Wiring points
|
|
18
|
+
|
|
19
|
+
- Voice wake: runtime/tester call `AppState.triggerVoiceEars(ttl: nil)` on trigger and `stopVoiceEars()` after 1s of silence to match the capture window.
|
|
20
|
+
- Agent activity: set `AppStateStore.shared.setWorking(true/false)` around work spans (already done in WebChat agent call). Keep spans short and reset in `defer` blocks to avoid stuck animations.
|
|
21
|
+
|
|
22
|
+
Shapes & sizes
|
|
23
|
+
|
|
24
|
+
- Base icon drawn in `CritterIconRenderer.makeIcon(blink:legWiggle:earWiggle:earScale:earHoles:)`.
|
|
25
|
+
- Ear scale defaults to `1.0`; voice boost sets `earScale=1.9` and toggles `earHoles=true` without changing overall frame (18×18 pt template image rendered into a 36×36 px Retina backing store).
|
|
26
|
+
- Scurry uses leg wiggle up to ~1.0 with a small horizontal jiggle; it's additive to any existing idle wiggle.
|
|
27
|
+
|
|
28
|
+
Behavioral notes
|
|
29
|
+
|
|
30
|
+
- No external CLI/broker toggle for ears/working; keep it internal to the app's own signals to avoid accidental flapping.
|
|
31
|
+
- Keep TTLs short (<10s) so the icon returns to baseline quickly if a job hangs.
|
|
32
|
+
|
|
33
|
+
## Related
|
|
34
|
+
|
|
35
|
+
- [Menu bar](/platforms/mac/menu-bar)
|
|
36
|
+
- [macOS app](/platforms/macos)
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Nodmix logging: rolling diagnostics file log + unified log privacy flags"
|
|
3
|
+
read_when:
|
|
4
|
+
- Capturing macOS logs or investigating private data logging
|
|
5
|
+
- Debugging voice wake/session lifecycle issues
|
|
6
|
+
title: "macOS logging"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Logging (macOS)
|
|
10
|
+
|
|
11
|
+
## Rolling diagnostics file log (Debug pane)
|
|
12
|
+
|
|
13
|
+
Nodmix routes macOS app logs through swift-log (unified logging by default) and can write a local, rotating file log to disk when you need a durable capture.
|
|
14
|
+
|
|
15
|
+
- Verbosity: **Debug pane → Logs → App logging → Verbosity**
|
|
16
|
+
- Enable: **Debug pane → Logs → App logging → "Write rolling diagnostics log (JSONL)"**
|
|
17
|
+
- Location: `~/Library/Logs/Nodmix/diagnostics.jsonl` (rotates automatically; old files are suffixed with `.1`, `.2`, …)
|
|
18
|
+
- Clear: **Debug pane → Logs → App logging → "Clear"**
|
|
19
|
+
|
|
20
|
+
Notes:
|
|
21
|
+
|
|
22
|
+
- This is **off by default**. Enable only while actively debugging.
|
|
23
|
+
- Treat the file as sensitive; don't share it without review.
|
|
24
|
+
|
|
25
|
+
## Unified logging private data on macOS
|
|
26
|
+
|
|
27
|
+
Unified logging redacts most payloads unless a subsystem opts into `privacy -off`. Per Peter's write-up on macOS [logging privacy shenanigans](https://steipete.me/posts/2025/logging-privacy-shenanigans) (2025) this is controlled by a plist in `/Library/Preferences/Logging/Subsystems/` keyed by the subsystem name. Only new log entries pick up the flag, so enable it before reproducing an issue.
|
|
28
|
+
|
|
29
|
+
## Enable for Nodmix (`ai.nodmix`)
|
|
30
|
+
|
|
31
|
+
- Write the plist to a temp file first, then install it atomically as root:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
cat <<'EOF' >/tmp/ai.nodmix.plist
|
|
35
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
36
|
+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
37
|
+
<plist version="1.0">
|
|
38
|
+
<dict>
|
|
39
|
+
<key>DEFAULT-OPTIONS</key>
|
|
40
|
+
<dict>
|
|
41
|
+
<key>Enable-Private-Data</key>
|
|
42
|
+
<true/>
|
|
43
|
+
</dict>
|
|
44
|
+
</dict>
|
|
45
|
+
</plist>
|
|
46
|
+
EOF
|
|
47
|
+
sudo install -m 644 -o root -g wheel /tmp/ai.nodmix.plist /Library/Preferences/Logging/Subsystems/ai.nodmix.plist
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
- No reboot is required; logd notices the file quickly, but only new log lines will include private payloads.
|
|
51
|
+
- View the richer output with the existing helper, e.g. `./scripts/clawlog.sh --category WebChat --last 5m`.
|
|
52
|
+
|
|
53
|
+
## Disable after debugging
|
|
54
|
+
|
|
55
|
+
- Remove the override: `sudo rm /Library/Preferences/Logging/Subsystems/ai.nodmix.plist`.
|
|
56
|
+
- Optionally run `sudo log config --reload` to force logd to drop the override immediately.
|
|
57
|
+
- Remember this surface can include phone numbers and message bodies; keep the plist in place only while you actively need the extra detail.
|
|
58
|
+
|
|
59
|
+
## Related
|
|
60
|
+
|
|
61
|
+
- [macOS app](/platforms/macos)
|
|
62
|
+
- [Gateway logging](/gateway/logging)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Menu bar status logic and what is surfaced to users"
|
|
3
|
+
read_when:
|
|
4
|
+
- Tweaking mac menu UI or status logic
|
|
5
|
+
title: "Menu bar"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## What is shown
|
|
9
|
+
|
|
10
|
+
- We surface the current agent work state in the menu bar icon and in the first status row of the menu.
|
|
11
|
+
- Health status is hidden while work is active; it returns when all sessions are idle.
|
|
12
|
+
- A root "Context" submenu contains recent sessions instead of expanding them directly in the root menu.
|
|
13
|
+
- The "Nodes" block in the root menu lists **devices** only (paired nodes via `node.list`), not client/presence entries.
|
|
14
|
+
- A root "Usage" section appears below Context when provider usage snapshots are available, followed by usage-cost details when available.
|
|
15
|
+
|
|
16
|
+
## State model
|
|
17
|
+
|
|
18
|
+
- Sessions: events arrive with `runId` (per-run) plus `sessionKey` in the payload. The "main" session is the key `main`; if absent, we fall back to the most recently updated session.
|
|
19
|
+
- Priority: main always wins. If main is active, its state is shown immediately. If main is idle, the most recently active non-main session is shown. We do not flip-flop mid-activity; we only switch when the current session goes idle or main becomes active.
|
|
20
|
+
- Activity kinds:
|
|
21
|
+
- `job`: high-level command execution (`state: started|streaming|done|error`).
|
|
22
|
+
- `tool`: `phase: start|result` with `toolName` and `meta/args`.
|
|
23
|
+
|
|
24
|
+
## IconState enum (Swift)
|
|
25
|
+
|
|
26
|
+
- `idle`
|
|
27
|
+
- `workingMain(ActivityKind)`
|
|
28
|
+
- `workingOther(ActivityKind)`
|
|
29
|
+
- `overridden(ActivityKind)` (debug override)
|
|
30
|
+
|
|
31
|
+
### ActivityKind → glyph
|
|
32
|
+
|
|
33
|
+
- `exec` → 💻
|
|
34
|
+
- `read` → 📄
|
|
35
|
+
- `write` → ✍️
|
|
36
|
+
- `edit` → 📝
|
|
37
|
+
- `attach` → 📎
|
|
38
|
+
- default → 🛠️
|
|
39
|
+
|
|
40
|
+
### Visual mapping
|
|
41
|
+
|
|
42
|
+
- `idle`: normal critter.
|
|
43
|
+
- `workingMain`: badge with glyph, full tint, leg "working" animation.
|
|
44
|
+
- `workingOther`: badge with glyph, muted tint, no scurry.
|
|
45
|
+
- `overridden`: uses the chosen glyph/tint regardless of activity.
|
|
46
|
+
|
|
47
|
+
## Context submenu
|
|
48
|
+
|
|
49
|
+
- The root menu shows one "Context" row with a session count/status and opens a submenu.
|
|
50
|
+
- The Context submenu header shows the active session count for the last 24 hours.
|
|
51
|
+
- Each session row keeps its token bar, age, preview, thinking/verbose, reset, compact, and delete actions.
|
|
52
|
+
- Loading, disconnected, and session-load error messages appear inside the Context submenu.
|
|
53
|
+
- Provider usage and usage-cost details stay root-level below Context so they remain glanceable without opening the submenu.
|
|
54
|
+
|
|
55
|
+
## Status row text (menu)
|
|
56
|
+
|
|
57
|
+
- While work is active: `<Session role> · <activity label>`
|
|
58
|
+
- Examples: `Main · exec: pnpm test`, `Other · read: apps/macos/Sources/Nodmix/AppState.swift`.
|
|
59
|
+
- When idle: falls back to the health summary.
|
|
60
|
+
|
|
61
|
+
## Event ingestion
|
|
62
|
+
|
|
63
|
+
- Source: control-channel `agent` events (`ControlChannel.handleAgentEvent`).
|
|
64
|
+
- Parsed fields:
|
|
65
|
+
- `stream: "job"` with `data.state` for start/stop.
|
|
66
|
+
- `stream: "tool"` with `data.phase`, `name`, optional `meta`/`args`.
|
|
67
|
+
- Labels:
|
|
68
|
+
- `exec`: first line of `args.command`.
|
|
69
|
+
- `read`/`write`: shortened path.
|
|
70
|
+
- `edit`: path plus inferred change kind from `meta`/diff counts.
|
|
71
|
+
- fallback: tool name.
|
|
72
|
+
|
|
73
|
+
## Debug override
|
|
74
|
+
|
|
75
|
+
- Settings ▸ Debug ▸ "Icon override" picker:
|
|
76
|
+
- `System (auto)` (default)
|
|
77
|
+
- `Working: main` (per tool kind)
|
|
78
|
+
- `Working: other` (per tool kind)
|
|
79
|
+
- `Idle`
|
|
80
|
+
- Stored via `@AppStorage("iconOverride")`; mapped to `IconState.overridden`.
|
|
81
|
+
|
|
82
|
+
## Testing checklist
|
|
83
|
+
|
|
84
|
+
- Trigger main session job: verify icon switches immediately and status row shows main label.
|
|
85
|
+
- Trigger non-main session job while main idle: icon/status shows non-main; stays stable until it finishes.
|
|
86
|
+
- Start main while other active: icon flips to main instantly.
|
|
87
|
+
- Rapid tool bursts: ensure badge does not flicker (TTL grace on tool results).
|
|
88
|
+
- Health row reappears once all sessions idle.
|
|
89
|
+
|
|
90
|
+
## Related
|
|
91
|
+
|
|
92
|
+
- [macOS app](/platforms/macos)
|
|
93
|
+
- [Menu bar icon](/platforms/mac/icon)
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "PeekabooBridge integration for macOS UI automation"
|
|
3
|
+
read_when:
|
|
4
|
+
- Hosting PeekabooBridge in Nodmix.app
|
|
5
|
+
- Integrating Peekaboo via Swift Package Manager
|
|
6
|
+
- Changing PeekabooBridge protocol/paths
|
|
7
|
+
- Deciding between PeekabooBridge, Codex Computer Use, and cua-driver MCP
|
|
8
|
+
title: "Peekaboo bridge"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Nodmix can host **PeekabooBridge** as a local, permission-aware UI automation
|
|
12
|
+
broker. This lets the `peekaboo` CLI drive UI automation while reusing the
|
|
13
|
+
macOS app's TCC permissions.
|
|
14
|
+
|
|
15
|
+
## What this is (and is not)
|
|
16
|
+
|
|
17
|
+
- **Host**: Nodmix.app can act as a PeekabooBridge host.
|
|
18
|
+
- **Client**: use the `peekaboo` CLI (no separate `nodmix ui ...` surface).
|
|
19
|
+
- **UI**: visual overlays stay in Peekaboo.app; Nodmix is a thin broker host.
|
|
20
|
+
|
|
21
|
+
## Relationship to Computer Use
|
|
22
|
+
|
|
23
|
+
Nodmix has three desktop-control paths, and they intentionally stay separate:
|
|
24
|
+
|
|
25
|
+
- **PeekabooBridge host**: Nodmix.app can host the local PeekabooBridge socket.
|
|
26
|
+
The `peekaboo` CLI remains the client and uses Nodmix.app's macOS
|
|
27
|
+
permissions for Peekaboo automation primitives such as screenshots, clicks,
|
|
28
|
+
menus, dialogs, Dock actions, and window management.
|
|
29
|
+
- **Codex Computer Use**: the bundled `codex` plugin prepares Codex app-server,
|
|
30
|
+
verifies that Codex's `computer-use` MCP server is available, and then lets
|
|
31
|
+
Codex own native desktop-control tool calls during Codex-mode turns. Nodmix
|
|
32
|
+
does not proxy those actions through PeekabooBridge.
|
|
33
|
+
- **Direct `cua-driver` MCP**: Nodmix can register TryCua's upstream
|
|
34
|
+
`cua-driver mcp` server as a normal MCP server. That gives agents the CUA
|
|
35
|
+
driver's own schemas and pid/window/element-index workflow without routing
|
|
36
|
+
through the Codex marketplace or the PeekabooBridge socket.
|
|
37
|
+
|
|
38
|
+
Use Peekaboo when you want the broad macOS automation surface and Nodmix.app's
|
|
39
|
+
permission-aware bridge host. Use Codex Computer Use when a Codex-mode agent
|
|
40
|
+
should rely on Codex's native computer-use plugin. Use direct `cua-driver mcp`
|
|
41
|
+
when you want the CUA driver exposed to any Nodmix-managed runtime as a normal
|
|
42
|
+
MCP server.
|
|
43
|
+
|
|
44
|
+
## Enable the bridge
|
|
45
|
+
|
|
46
|
+
In the macOS app:
|
|
47
|
+
|
|
48
|
+
- Settings → **Enable Peekaboo Bridge**
|
|
49
|
+
|
|
50
|
+
When enabled, Nodmix starts a local UNIX socket server. If disabled, the host
|
|
51
|
+
is stopped and `peekaboo` will fall back to other available hosts.
|
|
52
|
+
|
|
53
|
+
## Client discovery order
|
|
54
|
+
|
|
55
|
+
Peekaboo clients typically try hosts in this order:
|
|
56
|
+
|
|
57
|
+
1. Peekaboo.app (full UX)
|
|
58
|
+
2. Claude.app (if installed)
|
|
59
|
+
3. Nodmix.app (thin broker)
|
|
60
|
+
|
|
61
|
+
Use `peekaboo bridge status --verbose` to see which host is active and which
|
|
62
|
+
socket path is in use. You can override with:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
export PEEKABOO_BRIDGE_SOCKET=/path/to/bridge.sock
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Security and permissions
|
|
69
|
+
|
|
70
|
+
- The bridge validates **caller code signatures**; an allowlist of TeamIDs is
|
|
71
|
+
enforced (Peekaboo host TeamID + Nodmix app TeamID).
|
|
72
|
+
- Requests time out after ~10 seconds.
|
|
73
|
+
- If required permissions are missing, the bridge returns a clear error message
|
|
74
|
+
rather than launching System Settings.
|
|
75
|
+
|
|
76
|
+
## Snapshot behavior (automation)
|
|
77
|
+
|
|
78
|
+
Snapshots are stored in memory and expire automatically after a short window.
|
|
79
|
+
If you need longer retention, re-capture from the client.
|
|
80
|
+
|
|
81
|
+
## Troubleshooting
|
|
82
|
+
|
|
83
|
+
- If `peekaboo` reports "bridge client is not authorized", ensure the client is
|
|
84
|
+
properly signed or run the host with `PEEKABOO_ALLOW_UNSIGNED_SOCKET_CLIENTS=1`
|
|
85
|
+
in **debug** mode only.
|
|
86
|
+
- If no hosts are found, open one of the host apps (Peekaboo.app or Nodmix.app)
|
|
87
|
+
and confirm permissions are granted.
|
|
88
|
+
|
|
89
|
+
## Related
|
|
90
|
+
|
|
91
|
+
- [macOS app](/platforms/macos)
|
|
92
|
+
- [macOS permissions](/platforms/mac/permissions)
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "macOS permission persistence (TCC) and signing requirements"
|
|
3
|
+
read_when:
|
|
4
|
+
- Debugging missing or stuck macOS permission prompts
|
|
5
|
+
- Packaging or signing the macOS app
|
|
6
|
+
- Changing bundle IDs or app install paths
|
|
7
|
+
title: "macOS permissions"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
macOS permission grants are fragile. TCC associates a permission grant with the
|
|
11
|
+
app's code signature, bundle identifier, and on-disk path. If any of those change,
|
|
12
|
+
macOS treats the app as new and may drop or hide prompts.
|
|
13
|
+
|
|
14
|
+
## Requirements for stable permissions
|
|
15
|
+
|
|
16
|
+
- Same path: run the app from a fixed location (for Nodmix, `dist/Nodmix.app`).
|
|
17
|
+
- Same bundle identifier: changing the bundle ID creates a new permission identity.
|
|
18
|
+
- Signed app: unsigned or ad-hoc signed builds do not persist permissions.
|
|
19
|
+
- Consistent signature: use a real Apple Development or Developer ID certificate
|
|
20
|
+
so the signature stays stable across rebuilds.
|
|
21
|
+
|
|
22
|
+
Ad-hoc signatures generate a new identity every build. macOS will forget previous
|
|
23
|
+
grants, and prompts can disappear entirely until the stale entries are cleared.
|
|
24
|
+
|
|
25
|
+
## Recovery checklist when prompts disappear
|
|
26
|
+
|
|
27
|
+
1. Quit the app.
|
|
28
|
+
2. Remove the app entry in System Settings -> Privacy & Security.
|
|
29
|
+
3. Relaunch the app from the same path and re-grant permissions.
|
|
30
|
+
4. If the prompt still does not appear, reset TCC entries with `tccutil` and try again.
|
|
31
|
+
5. Some permissions only reappear after a full macOS restart.
|
|
32
|
+
|
|
33
|
+
Example resets (replace bundle ID as needed):
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
sudo tccutil reset Accessibility ai.nodmix.mac
|
|
37
|
+
sudo tccutil reset ScreenCapture ai.nodmix.mac
|
|
38
|
+
sudo tccutil reset AppleEvents
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Files and folders permissions (Desktop/Documents/Downloads)
|
|
42
|
+
|
|
43
|
+
macOS may also gate Desktop, Documents, and Downloads for terminal/background processes. If file reads or directory listings hang, grant access to the same process context that performs file operations (for example Terminal/iTerm, LaunchAgent-launched app, or SSH process).
|
|
44
|
+
|
|
45
|
+
Workaround: move files into the Nodmix workspace (`~/.nodmix/workspace`) if you want to avoid per-folder grants.
|
|
46
|
+
|
|
47
|
+
If you are testing permissions, always sign with a real certificate. Ad-hoc
|
|
48
|
+
builds are only acceptable for quick local runs where permissions do not matter.
|
|
49
|
+
|
|
50
|
+
## Related
|
|
51
|
+
|
|
52
|
+
- [macOS app](/platforms/macos)
|
|
53
|
+
- [macOS signing](/platforms/mac/signing)
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "macOS app flow for controlling a remote Nodmix gateway"
|
|
3
|
+
read_when:
|
|
4
|
+
- Setting up or debugging remote mac control
|
|
5
|
+
title: "Remote control"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
This flow lets the macOS app act as a full remote control for an Nodmix gateway running on another host (desktop/server). The app can connect directly to trusted LAN/Tailnet gateway URLs or manage an SSH tunnel when the remote gateway is loopback-only. Health checks, Voice Wake forwarding, and Web Chat reuse the same remote configuration from _Settings → General_.
|
|
9
|
+
|
|
10
|
+
## Modes
|
|
11
|
+
|
|
12
|
+
- **Local (this Mac)**: Everything runs on the laptop. No SSH involved.
|
|
13
|
+
- **Remote over SSH (default)**: Nodmix commands are executed on the remote host. The mac app opens an SSH connection with `-o BatchMode` plus your chosen identity/key and a local port-forward.
|
|
14
|
+
- **Remote direct (ws/wss)**: No SSH tunnel. The mac app connects to the gateway URL directly (for example, via LAN, Tailscale, Tailscale Serve, or a public HTTPS reverse proxy).
|
|
15
|
+
|
|
16
|
+
## Remote transports
|
|
17
|
+
|
|
18
|
+
Remote mode supports two transports:
|
|
19
|
+
|
|
20
|
+
- **SSH tunnel** (default): Uses `ssh -N -L ...` to forward the gateway port to localhost. The gateway will see the node's IP as `127.0.0.1` because the tunnel is loopback.
|
|
21
|
+
- **Direct (ws/wss)**: Connects straight to the gateway URL. The gateway sees the real client IP.
|
|
22
|
+
|
|
23
|
+
In SSH tunnel mode, discovered LAN/tailnet hostnames are saved as
|
|
24
|
+
`gateway.remote.sshTarget`. The app keeps `gateway.remote.url` on the local
|
|
25
|
+
tunnel endpoint, for example `ws://127.0.0.1:18789`, so CLI, Web Chat, and
|
|
26
|
+
the local node-host service all use the same safe loopback transport.
|
|
27
|
+
If the local tunnel port differs from the remote gateway port, set
|
|
28
|
+
`gateway.remote.remotePort` to the port on the remote host.
|
|
29
|
+
|
|
30
|
+
Browser automation in remote mode is owned by the CLI node host, not by the
|
|
31
|
+
native macOS app node. The app starts the installed node host service when
|
|
32
|
+
possible; if you need browser control from that Mac, install/start it with
|
|
33
|
+
`nodmix node install ...` and `nodmix node start` (or run
|
|
34
|
+
`nodmix node run ...` in the foreground), then target that browser-capable
|
|
35
|
+
node.
|
|
36
|
+
|
|
37
|
+
## Prereqs on the remote host
|
|
38
|
+
|
|
39
|
+
1. Install Node + pnpm and build/install the Nodmix CLI (`pnpm install && pnpm build && pnpm link --global`).
|
|
40
|
+
2. Ensure `nodmix` is on PATH for non-interactive shells (symlink into `/usr/local/bin` or `/opt/homebrew/bin` if needed).
|
|
41
|
+
3. For SSH transport only: open SSH with key auth. We recommend **Tailscale** IPs for stable reachability off-LAN.
|
|
42
|
+
|
|
43
|
+
## macOS app setup
|
|
44
|
+
|
|
45
|
+
To preconfigure the app without the welcome flow:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
nodmix-mac configure-remote \
|
|
49
|
+
--ssh-target user@gateway.local \
|
|
50
|
+
--local-port 18789 \
|
|
51
|
+
--remote-port 18789 \
|
|
52
|
+
--token "$NODMIX_GATEWAY_TOKEN"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
For a gateway already reachable on a trusted LAN or Tailnet, skip SSH entirely:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
nodmix-mac configure-remote \
|
|
59
|
+
--direct-url ws://192.168.0.202:18789 \
|
|
60
|
+
--token "$NODMIX_GATEWAY_TOKEN"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
This writes the remote config, marks onboarding complete, and lets the app own
|
|
64
|
+
the selected transport when it starts.
|
|
65
|
+
|
|
66
|
+
1. Open _Settings → General_.
|
|
67
|
+
2. Under **Nodmix runs**, pick **Remote** and set:
|
|
68
|
+
- **Transport**: **SSH tunnel** or **Direct (ws/wss)**.
|
|
69
|
+
- **SSH target**: `user@host` (optional `:port`).
|
|
70
|
+
- If the gateway is on the same LAN and advertises Bonjour, pick it from the discovered list to auto-fill this field.
|
|
71
|
+
- **Gateway URL** (Direct only): `wss://gateway.example.ts.net` (or `ws://...` for local/LAN).
|
|
72
|
+
- **Identity file** (advanced): path to your key.
|
|
73
|
+
- **Project root** (advanced): remote checkout path used for commands.
|
|
74
|
+
- **CLI path** (advanced): optional path to a runnable `nodmix` entrypoint/binary (auto-filled when advertised).
|
|
75
|
+
3. Hit **Test remote**. Success indicates the remote `nodmix status --json` runs correctly. Failures usually mean PATH/CLI issues; exit 127 means the CLI isn't found remotely.
|
|
76
|
+
4. Health checks and Web Chat will now run through the selected transport automatically.
|
|
77
|
+
|
|
78
|
+
## Web Chat
|
|
79
|
+
|
|
80
|
+
- **SSH tunnel**: Web Chat connects to the gateway over the forwarded WebSocket control port (default 18789).
|
|
81
|
+
- **Direct (ws/wss)**: Web Chat connects straight to the configured gateway URL.
|
|
82
|
+
- There is no separate WebChat HTTP server anymore.
|
|
83
|
+
|
|
84
|
+
## Permissions
|
|
85
|
+
|
|
86
|
+
- The remote host needs the same TCC approvals as local (Automation, Accessibility, Screen Recording, Microphone, Speech Recognition, Notifications). Run onboarding on that machine to grant them once.
|
|
87
|
+
- Nodes advertise their permission state via `node.list` / `node.describe` so agents know what's available.
|
|
88
|
+
|
|
89
|
+
## Security notes
|
|
90
|
+
|
|
91
|
+
- Prefer loopback binds on the remote host and connect via SSH, Tailscale Serve, or a trusted Tailnet/LAN direct URL.
|
|
92
|
+
- SSH tunneling uses strict host-key checking; trust the host key first so it exists in `~/.ssh/known_hosts`.
|
|
93
|
+
- If you bind the Gateway to a non-loopback interface, require valid Gateway auth: token, password, or an identity-aware reverse proxy with `gateway.auth.mode: "trusted-proxy"`.
|
|
94
|
+
- See [Security](/gateway/security) and [Tailscale](/gateway/tailscale).
|
|
95
|
+
|
|
96
|
+
## WhatsApp login flow (remote)
|
|
97
|
+
|
|
98
|
+
- Run `nodmix channels login --verbose` **on the remote host**. Scan the QR with WhatsApp on your phone.
|
|
99
|
+
- Re-run login on that host if auth expires. Health check will surface link problems.
|
|
100
|
+
|
|
101
|
+
## Troubleshooting
|
|
102
|
+
|
|
103
|
+
- **exit 127 / not found**: `nodmix` isn't on PATH for non-login shells. Add it to `/etc/paths`, your shell rc, or symlink into `/usr/local/bin`/`/opt/homebrew/bin`.
|
|
104
|
+
- **Health probe failed**: check SSH reachability, PATH, and that Baileys is logged in (`nodmix status --json`).
|
|
105
|
+
- **Web Chat stuck**: confirm the gateway is running on the remote host and the forwarded port matches the gateway WS port; the UI requires a healthy WS connection.
|
|
106
|
+
- **Node IP shows 127.0.0.1**: expected with the SSH tunnel. Switch **Transport** to **Direct (ws/wss)** if you want the gateway to see the real client IP.
|
|
107
|
+
- **Dashboard works but Mac capabilities are offline**: this means the app's operator/control connection is healthy, but the companion node connection is not connected or is missing its command surface. Open the menu bar device section and check whether the Mac is `paired · disconnected`. For `wss://*.ts.net` Tailscale Serve endpoints, the app detects stale legacy TLS leaf pins after certificate rotation, clears the stale pin when macOS trusts the new certificate, and retries automatically. If the certificate is not system-trusted or the host is not a Tailscale Serve name, set `gateway.remote.tlsFingerprint` to the expected certificate fingerprint, review the certificate, or switch to **Remote over SSH**.
|
|
108
|
+
- **Voice Wake**: trigger phrases are forwarded automatically in remote mode; no separate forwarder is needed.
|
|
109
|
+
|
|
110
|
+
## Notification sounds
|
|
111
|
+
|
|
112
|
+
Pick sounds per notification from scripts with `nodmix` and `node.invoke`, e.g.:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
nodmix nodes notify --node <id> --title "Ping" --body "Remote gateway ready" --sound Glass
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
There is no global "default sound" toggle in the app anymore; callers choose a sound (or none) per request.
|
|
119
|
+
|
|
120
|
+
## Related
|
|
121
|
+
|
|
122
|
+
- [macOS app](/platforms/macos)
|
|
123
|
+
- [Remote access](/gateway/remote)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Signing steps for macOS debug builds generated by packaging scripts"
|
|
3
|
+
read_when:
|
|
4
|
+
- Building or signing mac debug builds
|
|
5
|
+
title: "macOS signing"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# mac signing (debug builds)
|
|
9
|
+
|
|
10
|
+
This app is usually built from [`scripts/package-mac-app.sh`](https://github.com/nodmix/nodmix/blob/main/scripts/package-mac-app.sh), which now:
|
|
11
|
+
|
|
12
|
+
- sets a stable debug bundle identifier: `ai.nodmix.mac.debug`
|
|
13
|
+
- writes the Info.plist with that bundle id (override via `BUNDLE_ID=...`)
|
|
14
|
+
- calls [`scripts/codesign-mac-app.sh`](https://github.com/nodmix/nodmix/blob/main/scripts/codesign-mac-app.sh) to sign the main binary and app bundle so macOS treats each rebuild as the same signed bundle and keeps TCC permissions (notifications, accessibility, screen recording, mic, speech). For stable permissions, use a real signing identity; ad-hoc is opt-in and fragile (see [macOS permissions](/platforms/mac/permissions)).
|
|
15
|
+
- uses `CODESIGN_TIMESTAMP=auto` by default; it enables trusted timestamps for Developer ID signatures. Set `CODESIGN_TIMESTAMP=off` to skip timestamping (offline debug builds).
|
|
16
|
+
- inject build metadata into Info.plist: `NodmixBuildTimestamp` (UTC) and `NodmixGitCommit` (short hash) so the About pane can show build, git, and debug/release channel.
|
|
17
|
+
- **Packaging defaults to Node 24**: the script runs TS builds and the Control UI build. Node 22 LTS, currently `22.19+`, remains supported for compatibility.
|
|
18
|
+
- reads `SIGN_IDENTITY` from the environment. Add `export SIGN_IDENTITY="Apple Development: Your Name (TEAMID)"` (or your Developer ID Application cert) to your shell rc to always sign with your cert. Ad-hoc signing requires explicit opt-in via `ALLOW_ADHOC_SIGNING=1` or `SIGN_IDENTITY="-"` (not recommended for permission testing).
|
|
19
|
+
- runs a Team ID audit after signing and fails if any Mach-O inside the app bundle is signed by a different Team ID. Set `SKIP_TEAM_ID_CHECK=1` to bypass.
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# from repo root
|
|
25
|
+
scripts/package-mac-app.sh # auto-selects identity; errors if none found
|
|
26
|
+
SIGN_IDENTITY="Developer ID Application: Your Name" scripts/package-mac-app.sh # real cert
|
|
27
|
+
ALLOW_ADHOC_SIGNING=1 scripts/package-mac-app.sh # ad-hoc (permissions will not stick)
|
|
28
|
+
SIGN_IDENTITY="-" scripts/package-mac-app.sh # explicit ad-hoc (same caveat)
|
|
29
|
+
DISABLE_LIBRARY_VALIDATION=1 scripts/package-mac-app.sh # dev-only Sparkle Team ID mismatch workaround
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Ad-hoc Signing Note
|
|
33
|
+
|
|
34
|
+
When signing with `SIGN_IDENTITY="-"` (ad-hoc), the script automatically disables the **Hardened Runtime** (`--options runtime`). This is necessary to prevent crashes when the app attempts to load embedded frameworks (like Sparkle) that do not share the same Team ID. Ad-hoc signatures also break TCC permission persistence; see [macOS permissions](/platforms/mac/permissions) for recovery steps.
|
|
35
|
+
|
|
36
|
+
## Build metadata for About
|
|
37
|
+
|
|
38
|
+
`package-mac-app.sh` stamps the bundle with:
|
|
39
|
+
|
|
40
|
+
- `NodmixBuildTimestamp`: ISO8601 UTC at package time
|
|
41
|
+
- `NodmixGitCommit`: short git hash (or `unknown` if unavailable)
|
|
42
|
+
|
|
43
|
+
The About tab reads these keys to show version, build date, git commit, and whether it's a debug build (via `#if DEBUG`). Run the packager to refresh these values after code changes.
|
|
44
|
+
|
|
45
|
+
## Why
|
|
46
|
+
|
|
47
|
+
TCC permissions are tied to the bundle identifier _and_ code signature. Unsigned debug builds with changing UUIDs were causing macOS to forget grants after each rebuild. Signing the binaries (ad-hoc by default) and keeping a fixed bundle id/path (`dist/Nodmix.app`) preserves the grants between builds, matching the VibeTunnel approach.
|
|
48
|
+
|
|
49
|
+
## Related
|
|
50
|
+
|
|
51
|
+
- [macOS app](/platforms/macos)
|
|
52
|
+
- [macOS permissions](/platforms/mac/permissions)
|