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,331 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Complete reference for CLI setup flow, auth/model setup, outputs, and internals"
|
|
3
|
+
read_when:
|
|
4
|
+
- You need detailed behavior for nodmix onboard
|
|
5
|
+
- You are debugging onboarding results or integrating onboarding clients
|
|
6
|
+
title: "CLI setup reference"
|
|
7
|
+
sidebarTitle: "CLI reference"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
This page is the full reference for `nodmix onboard`.
|
|
11
|
+
For the short guide, see [Onboarding (CLI)](/start/wizard).
|
|
12
|
+
|
|
13
|
+
## What the wizard does
|
|
14
|
+
|
|
15
|
+
Local mode (default) walks you through:
|
|
16
|
+
|
|
17
|
+
- Model and auth setup (OpenAI Code subscription OAuth, Anthropic Claude CLI or API key, plus MiniMax, GLM, Ollama, Moonshot, StepFun, and AI Gateway options)
|
|
18
|
+
- Workspace location and bootstrap files
|
|
19
|
+
- Gateway settings (port, bind, auth, tailscale)
|
|
20
|
+
- Channels and providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage, and other bundled channel plugins)
|
|
21
|
+
- Daemon install (LaunchAgent, systemd user unit, or native Windows Scheduled Task with Startup-folder fallback)
|
|
22
|
+
- Health check
|
|
23
|
+
- Skills setup
|
|
24
|
+
|
|
25
|
+
Remote mode configures this machine to connect to a gateway elsewhere.
|
|
26
|
+
It does not install or modify anything on the remote host.
|
|
27
|
+
|
|
28
|
+
## Local flow details
|
|
29
|
+
|
|
30
|
+
<Steps>
|
|
31
|
+
<Step title="Existing config detection">
|
|
32
|
+
- If `~/.nodmix/nodmix.json` exists, choose Keep, Modify, or Reset.
|
|
33
|
+
- Re-running the wizard does not wipe anything unless you explicitly choose Reset (or pass `--reset`).
|
|
34
|
+
- CLI `--reset` defaults to `config+creds+sessions`; use `--reset-scope full` to also remove workspace.
|
|
35
|
+
- If config is invalid or contains legacy keys, the wizard stops and asks you to run `nodmix doctor` before continuing.
|
|
36
|
+
- Reset uses `trash` and offers scopes:
|
|
37
|
+
- Config only
|
|
38
|
+
- Config + credentials + sessions
|
|
39
|
+
- Full reset (also removes workspace)
|
|
40
|
+
|
|
41
|
+
</Step>
|
|
42
|
+
<Step title="Model and auth">
|
|
43
|
+
- Full option matrix is in [Auth and model options](#auth-and-model-options).
|
|
44
|
+
|
|
45
|
+
</Step>
|
|
46
|
+
<Step title="Workspace">
|
|
47
|
+
- Default `~/.nodmix/workspace` (configurable).
|
|
48
|
+
- Seeds workspace files needed for first-run bootstrap ritual.
|
|
49
|
+
- Workspace layout: [Agent workspace](/concepts/agent-workspace).
|
|
50
|
+
|
|
51
|
+
</Step>
|
|
52
|
+
<Step title="Gateway">
|
|
53
|
+
- Prompts for port, bind, auth mode, and tailscale exposure.
|
|
54
|
+
- Recommended: keep token auth enabled even for loopback so local WS clients must authenticate.
|
|
55
|
+
- In token mode, interactive setup offers:
|
|
56
|
+
- **Generate/store plaintext token** (default)
|
|
57
|
+
- **Use SecretRef** (opt-in)
|
|
58
|
+
- In password mode, interactive setup also supports plaintext or SecretRef storage.
|
|
59
|
+
- Non-interactive token SecretRef path: `--gateway-token-ref-env <ENV_VAR>`.
|
|
60
|
+
- Requires a non-empty env var in the onboarding process environment.
|
|
61
|
+
- Cannot be combined with `--gateway-token`.
|
|
62
|
+
- Disable auth only if you fully trust every local process.
|
|
63
|
+
- Non-loopback binds still require auth.
|
|
64
|
+
|
|
65
|
+
</Step>
|
|
66
|
+
<Step title="Channels">
|
|
67
|
+
- [WhatsApp](/channels/whatsapp): optional QR login
|
|
68
|
+
- [Telegram](/channels/telegram): bot token
|
|
69
|
+
- [Discord](/channels/discord): bot token
|
|
70
|
+
- [Google Chat](/channels/googlechat): service account JSON + webhook audience
|
|
71
|
+
- [Mattermost](/channels/mattermost): bot token + base URL
|
|
72
|
+
- [Signal](/channels/signal): optional `signal-cli` install + account config
|
|
73
|
+
- [iMessage](/channels/imessage): `imsg` CLI path + Messages DB access; use an SSH wrapper when the Gateway runs off-Mac
|
|
74
|
+
- DM security: default is pairing. First DM sends a code; approve via
|
|
75
|
+
`nodmix pairing approve <channel> <code>` or use allowlists.
|
|
76
|
+
</Step>
|
|
77
|
+
<Step title="Daemon install">
|
|
78
|
+
- macOS: LaunchAgent
|
|
79
|
+
- Requires logged-in user session; for headless, use a custom LaunchDaemon (not shipped).
|
|
80
|
+
- Linux and Windows via WSL2: systemd user unit
|
|
81
|
+
- Wizard attempts `loginctl enable-linger <user>` so gateway stays up after logout.
|
|
82
|
+
- May prompt for sudo (writes `/var/lib/systemd/linger`); it tries without sudo first.
|
|
83
|
+
- Native Windows: Scheduled Task first
|
|
84
|
+
- If task creation is denied, Nodmix falls back to a per-user Startup-folder login item and starts the gateway immediately.
|
|
85
|
+
- Scheduled Tasks remain preferred because they provide better supervisor status.
|
|
86
|
+
- Runtime selection: Node (recommended; required for WhatsApp and Telegram). Bun is not recommended.
|
|
87
|
+
|
|
88
|
+
</Step>
|
|
89
|
+
<Step title="Health check">
|
|
90
|
+
- Starts gateway (if needed) and runs `nodmix health`.
|
|
91
|
+
- `nodmix status --deep` adds the live gateway health probe to status output, including channel probes when supported.
|
|
92
|
+
|
|
93
|
+
</Step>
|
|
94
|
+
<Step title="Skills">
|
|
95
|
+
- Reads available skills and checks requirements.
|
|
96
|
+
- Lets you choose node manager: npm, pnpm, or bun.
|
|
97
|
+
- Installs optional dependencies (some use Homebrew on macOS).
|
|
98
|
+
|
|
99
|
+
</Step>
|
|
100
|
+
<Step title="Finish">
|
|
101
|
+
- Summary and next steps, including iOS, Android, and macOS app options.
|
|
102
|
+
|
|
103
|
+
</Step>
|
|
104
|
+
</Steps>
|
|
105
|
+
|
|
106
|
+
<Note>
|
|
107
|
+
If no GUI is detected, the wizard prints SSH port-forward instructions for the Control UI instead of opening a browser.
|
|
108
|
+
If Control UI assets are missing, the wizard attempts to build them; fallback is `pnpm ui:build` (auto-installs UI deps).
|
|
109
|
+
</Note>
|
|
110
|
+
|
|
111
|
+
## Remote mode details
|
|
112
|
+
|
|
113
|
+
Remote mode configures this machine to connect to a gateway elsewhere.
|
|
114
|
+
|
|
115
|
+
<Info>
|
|
116
|
+
Remote mode does not install or modify anything on the remote host.
|
|
117
|
+
</Info>
|
|
118
|
+
|
|
119
|
+
What you set:
|
|
120
|
+
|
|
121
|
+
- Remote gateway URL (`ws://...`)
|
|
122
|
+
- Token if remote gateway auth is required (recommended)
|
|
123
|
+
|
|
124
|
+
<Note>
|
|
125
|
+
- If gateway is loopback-only, use SSH tunneling or a tailnet.
|
|
126
|
+
- Discovery hints:
|
|
127
|
+
- macOS: Bonjour (`dns-sd`)
|
|
128
|
+
- Linux: Avahi (`avahi-browse`)
|
|
129
|
+
|
|
130
|
+
</Note>
|
|
131
|
+
|
|
132
|
+
## Auth and model options
|
|
133
|
+
|
|
134
|
+
<AccordionGroup>
|
|
135
|
+
<Accordion title="Anthropic API key">
|
|
136
|
+
Uses `ANTHROPIC_API_KEY` if present or prompts for a key, then saves it for daemon use.
|
|
137
|
+
</Accordion>
|
|
138
|
+
<Accordion title="OpenAI Code subscription (OAuth)">
|
|
139
|
+
Browser flow; paste `code#state`.
|
|
140
|
+
|
|
141
|
+
Sets `agents.defaults.model` to `openai/gpt-5.5` through the Codex runtime when model is unset or already OpenAI-family.
|
|
142
|
+
|
|
143
|
+
</Accordion>
|
|
144
|
+
<Accordion title="OpenAI Code subscription (device pairing)">
|
|
145
|
+
Browser pairing flow with a short-lived device code.
|
|
146
|
+
|
|
147
|
+
Sets `agents.defaults.model` to `openai/gpt-5.5` through the Codex runtime when model is unset or already OpenAI-family.
|
|
148
|
+
|
|
149
|
+
</Accordion>
|
|
150
|
+
<Accordion title="OpenAI API key">
|
|
151
|
+
Uses `OPENAI_API_KEY` if present or prompts for a key, then stores the credential in auth profiles.
|
|
152
|
+
|
|
153
|
+
Sets `agents.defaults.model` to `openai/gpt-5.5` when model is unset, `openai/*`, or `openai-codex/*`.
|
|
154
|
+
|
|
155
|
+
</Accordion>
|
|
156
|
+
<Accordion title="xAI (Grok) OAuth">
|
|
157
|
+
Browser sign-in for eligible SuperGrok or X Premium accounts. This is the
|
|
158
|
+
recommended xAI path for most users. Nodmix stores the resulting auth
|
|
159
|
+
profile for Grok models, `x_search`, and `code_execution`.
|
|
160
|
+
</Accordion>
|
|
161
|
+
<Accordion title="xAI (Grok) device code">
|
|
162
|
+
Remote-friendly browser sign-in with a short code instead of a localhost
|
|
163
|
+
callback. Use this from SSH, Docker, or VPS hosts.
|
|
164
|
+
</Accordion>
|
|
165
|
+
<Accordion title="xAI (Grok) API key">
|
|
166
|
+
Prompts for `XAI_API_KEY` and configures xAI as a model provider. Use this
|
|
167
|
+
when you want an xAI Console API key instead of subscription OAuth.
|
|
168
|
+
</Accordion>
|
|
169
|
+
<Accordion title="OpenCode">
|
|
170
|
+
Prompts for `OPENCODE_API_KEY` (or `OPENCODE_ZEN_API_KEY`) and lets you choose the Zen or Go catalog.
|
|
171
|
+
Setup URL: [opencode.ai/auth](https://opencode.ai/auth).
|
|
172
|
+
</Accordion>
|
|
173
|
+
<Accordion title="API key (generic)">
|
|
174
|
+
Stores the key for you.
|
|
175
|
+
</Accordion>
|
|
176
|
+
<Accordion title="Vercel AI Gateway">
|
|
177
|
+
Prompts for `AI_GATEWAY_API_KEY`.
|
|
178
|
+
More detail: [Vercel AI Gateway](/providers/vercel-ai-gateway).
|
|
179
|
+
</Accordion>
|
|
180
|
+
<Accordion title="Cloudflare AI Gateway">
|
|
181
|
+
Prompts for account ID, gateway ID, and `CLOUDFLARE_AI_GATEWAY_API_KEY`.
|
|
182
|
+
More detail: [Cloudflare AI Gateway](/providers/cloudflare-ai-gateway).
|
|
183
|
+
</Accordion>
|
|
184
|
+
<Accordion title="MiniMax">
|
|
185
|
+
Config is auto-written. Hosted default is `MiniMax-M2.7`; API-key setup uses
|
|
186
|
+
`minimax/...`, and OAuth setup uses `minimax-portal/...`.
|
|
187
|
+
More detail: [MiniMax](/providers/minimax).
|
|
188
|
+
</Accordion>
|
|
189
|
+
<Accordion title="StepFun">
|
|
190
|
+
Config is auto-written for StepFun standard or Step Plan on China or global endpoints.
|
|
191
|
+
Standard currently includes `step-3.5-flash`, and Step Plan also includes `step-3.5-flash-2603`.
|
|
192
|
+
More detail: [StepFun](/providers/stepfun).
|
|
193
|
+
</Accordion>
|
|
194
|
+
<Accordion title="Synthetic (Anthropic-compatible)">
|
|
195
|
+
Prompts for `SYNTHETIC_API_KEY`.
|
|
196
|
+
More detail: [Synthetic](/providers/synthetic).
|
|
197
|
+
</Accordion>
|
|
198
|
+
<Accordion title="Ollama (Cloud and local open models)">
|
|
199
|
+
Prompts for `Cloud + Local`, `Cloud only`, or `Local only` first.
|
|
200
|
+
`Cloud only` uses `OLLAMA_API_KEY` with `https://ollama.com`.
|
|
201
|
+
The host-backed modes prompt for base URL (default `http://127.0.0.1:11434`), discover available models, and suggest defaults.
|
|
202
|
+
`Cloud + Local` also checks whether that Ollama host is signed in for cloud access.
|
|
203
|
+
More detail: [Ollama](/providers/ollama).
|
|
204
|
+
</Accordion>
|
|
205
|
+
<Accordion title="Moonshot and Kimi Coding">
|
|
206
|
+
Moonshot (Kimi K2) and Kimi Coding configs are auto-written.
|
|
207
|
+
More detail: [Moonshot AI (Kimi + Kimi Coding)](/providers/moonshot).
|
|
208
|
+
</Accordion>
|
|
209
|
+
<Accordion title="Custom provider">
|
|
210
|
+
Works with OpenAI-compatible and Anthropic-compatible endpoints.
|
|
211
|
+
|
|
212
|
+
Interactive onboarding supports the same API key storage choices as other provider API key flows:
|
|
213
|
+
- **Paste API key now** (plaintext)
|
|
214
|
+
- **Use secret reference** (env ref or configured provider ref, with preflight validation)
|
|
215
|
+
|
|
216
|
+
Non-interactive flags:
|
|
217
|
+
- `--auth-choice custom-api-key`
|
|
218
|
+
- `--custom-base-url`
|
|
219
|
+
- `--custom-model-id`
|
|
220
|
+
- `--custom-api-key` (optional; falls back to `CUSTOM_API_KEY`)
|
|
221
|
+
- `--custom-provider-id` (optional)
|
|
222
|
+
- `--custom-compatibility <openai|anthropic>` (optional; default `openai`)
|
|
223
|
+
- `--custom-image-input` / `--custom-text-input` (optional; override inferred model input capability)
|
|
224
|
+
|
|
225
|
+
</Accordion>
|
|
226
|
+
<Accordion title="Skip">
|
|
227
|
+
Leaves auth unconfigured.
|
|
228
|
+
</Accordion>
|
|
229
|
+
</AccordionGroup>
|
|
230
|
+
|
|
231
|
+
Model behavior:
|
|
232
|
+
|
|
233
|
+
- Pick default model from detected options, or enter provider and model manually.
|
|
234
|
+
- Custom-provider onboarding infers image support for common model IDs and asks only when the model name is unknown.
|
|
235
|
+
- When onboarding starts from a provider auth choice, the model picker prefers
|
|
236
|
+
that provider automatically. For Volcengine and BytePlus, the same preference
|
|
237
|
+
also matches their coding-plan variants (`volcengine-plan/*`,
|
|
238
|
+
`byteplus-plan/*`).
|
|
239
|
+
- If that preferred-provider filter would be empty, the picker falls back to
|
|
240
|
+
the full catalog instead of showing no models.
|
|
241
|
+
- Wizard runs a model check and warns if the configured model is unknown or missing auth.
|
|
242
|
+
|
|
243
|
+
Credential and profile paths:
|
|
244
|
+
|
|
245
|
+
- Auth profiles (API keys + OAuth): `~/.nodmix/agents/<agentId>/agent/auth-profiles.json`
|
|
246
|
+
- Legacy OAuth import: `~/.nodmix/credentials/oauth.json`
|
|
247
|
+
|
|
248
|
+
Credential storage mode:
|
|
249
|
+
|
|
250
|
+
- Default onboarding behavior persists API keys as plaintext values in auth profiles.
|
|
251
|
+
- `--secret-input-mode ref` enables reference mode instead of plaintext key storage.
|
|
252
|
+
In interactive setup, you can choose either:
|
|
253
|
+
- environment variable ref (for example `keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }`)
|
|
254
|
+
- configured provider ref (`file` or `exec`) with provider alias + id
|
|
255
|
+
- Interactive reference mode runs a fast preflight validation before saving.
|
|
256
|
+
- Env refs: validates variable name + non-empty value in the current onboarding environment.
|
|
257
|
+
- Provider refs: validates provider config and resolves the requested id.
|
|
258
|
+
- If preflight fails, onboarding shows the error and lets you retry.
|
|
259
|
+
- In non-interactive mode, `--secret-input-mode ref` is env-backed only.
|
|
260
|
+
- Set the provider env var in the onboarding process environment.
|
|
261
|
+
- Inline key flags (for example `--openai-api-key`) require that env var to be set; otherwise onboarding fails fast.
|
|
262
|
+
- For custom providers, non-interactive `ref` mode stores `models.providers.<id>.apiKey` as `{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }`.
|
|
263
|
+
- In that custom-provider case, `--custom-api-key` requires `CUSTOM_API_KEY` to be set; otherwise onboarding fails fast.
|
|
264
|
+
- Gateway auth credentials support plaintext and SecretRef choices in interactive setup:
|
|
265
|
+
- Token mode: **Generate/store plaintext token** (default) or **Use SecretRef**.
|
|
266
|
+
- Password mode: plaintext or SecretRef.
|
|
267
|
+
- Non-interactive token SecretRef path: `--gateway-token-ref-env <ENV_VAR>`.
|
|
268
|
+
- Existing plaintext setups continue to work unchanged.
|
|
269
|
+
|
|
270
|
+
<Note>
|
|
271
|
+
Headless and server tip: complete OAuth on a machine with a browser, then copy
|
|
272
|
+
that agent's `auth-profiles.json` (for example
|
|
273
|
+
`~/.nodmix/agents/<agentId>/agent/auth-profiles.json`, or the matching
|
|
274
|
+
`$NODMIX_STATE_DIR/...` path) to the gateway host. `credentials/oauth.json`
|
|
275
|
+
is only a legacy import source.
|
|
276
|
+
</Note>
|
|
277
|
+
|
|
278
|
+
## Outputs and internals
|
|
279
|
+
|
|
280
|
+
Typical fields in `~/.nodmix/nodmix.json`:
|
|
281
|
+
|
|
282
|
+
- `agents.defaults.workspace`
|
|
283
|
+
- `agents.defaults.skipBootstrap` when `--skip-bootstrap` is passed
|
|
284
|
+
- `agents.defaults.model` / `models.providers` (if Minimax chosen)
|
|
285
|
+
- `tools.profile` (local onboarding defaults to `"coding"` when unset; existing explicit values are preserved)
|
|
286
|
+
- `gateway.*` (mode, bind, auth, tailscale)
|
|
287
|
+
- `session.dmScope` (local onboarding defaults this to `per-channel-peer` when unset; existing explicit values are preserved)
|
|
288
|
+
- `channels.telegram.botToken`, `channels.discord.token`, `channels.matrix.*`, `channels.signal.*`, `channels.imessage.*`
|
|
289
|
+
- Channel allowlists (Slack, Discord, Matrix, Microsoft Teams) when you opt in during prompts (names resolve to IDs when possible)
|
|
290
|
+
- `skills.install.nodeManager`
|
|
291
|
+
- The `setup --node-manager` flag accepts `npm`, `pnpm`, or `bun`.
|
|
292
|
+
- Manual config can still set `skills.install.nodeManager: "yarn"` later.
|
|
293
|
+
- `wizard.lastRunAt`
|
|
294
|
+
- `wizard.lastRunVersion`
|
|
295
|
+
- `wizard.lastRunCommit`
|
|
296
|
+
- `wizard.lastRunCommand`
|
|
297
|
+
- `wizard.lastRunMode`
|
|
298
|
+
|
|
299
|
+
`nodmix agents add` writes `agents.list[]` and optional `bindings`.
|
|
300
|
+
|
|
301
|
+
WhatsApp credentials go under `~/.nodmix/credentials/whatsapp/<accountId>/`.
|
|
302
|
+
Sessions are stored under `~/.nodmix/agents/<agentId>/sessions/`.
|
|
303
|
+
|
|
304
|
+
<Note>
|
|
305
|
+
Some channels are delivered as plugins. When selected during setup, the wizard
|
|
306
|
+
prompts to install the plugin (npm or local path) before channel configuration.
|
|
307
|
+
</Note>
|
|
308
|
+
|
|
309
|
+
Gateway wizard RPC:
|
|
310
|
+
|
|
311
|
+
- `wizard.start`
|
|
312
|
+
- `wizard.next`
|
|
313
|
+
- `wizard.cancel`
|
|
314
|
+
- `wizard.status`
|
|
315
|
+
|
|
316
|
+
Clients (macOS app and Control UI) can render steps without re-implementing onboarding logic.
|
|
317
|
+
|
|
318
|
+
Signal setup behavior:
|
|
319
|
+
|
|
320
|
+
- Downloads the appropriate release asset
|
|
321
|
+
- Stores it under `~/.nodmix/tools/signal-cli/<version>/`
|
|
322
|
+
- Writes `channels.signal.cliPath` in config
|
|
323
|
+
- JVM builds require Java 21
|
|
324
|
+
- Native builds are used when available
|
|
325
|
+
- Windows uses WSL2 and follows Linux signal-cli flow inside WSL
|
|
326
|
+
|
|
327
|
+
## Related docs
|
|
328
|
+
|
|
329
|
+
- Onboarding hub: [Onboarding (CLI)](/start/wizard)
|
|
330
|
+
- Automation and scripts: [CLI Automation](/start/wizard-cli-automation)
|
|
331
|
+
- Command reference: [`nodmix onboard`](/cli/onboard)
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI onboarding: guided setup for gateway, workspace, channels, and skills"
|
|
3
|
+
read_when:
|
|
4
|
+
- Running or configuring CLI onboarding
|
|
5
|
+
- Setting up a new machine
|
|
6
|
+
title: "Onboarding (CLI)"
|
|
7
|
+
sidebarTitle: "Onboarding: CLI"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
CLI onboarding is the **recommended** way to set up Nodmix on macOS,
|
|
11
|
+
Linux, or Windows (via WSL2; strongly recommended).
|
|
12
|
+
It configures a local Gateway or a remote Gateway connection, plus channels, skills,
|
|
13
|
+
and workspace defaults in one guided flow.
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
nodmix onboard
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Locale
|
|
20
|
+
|
|
21
|
+
The CLI wizard localizes fixed onboarding copy. It resolves locale from
|
|
22
|
+
`NODMIX_LOCALE`, then `LC_ALL`, then `LC_MESSAGES`, then `LANG`, and falls
|
|
23
|
+
back to English. Supported wizard locales are `en`, `zh-CN`, and `zh-TW`.
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
NODMIX_LOCALE=zh-CN nodmix onboard
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Names and stable identifiers stay literal: `Nodmix`, `Gateway`, `Tailscale`,
|
|
30
|
+
commands, config keys, URLs, provider IDs, model IDs, and plugin/channel labels
|
|
31
|
+
are not translated.
|
|
32
|
+
|
|
33
|
+
<Info>
|
|
34
|
+
Fastest first chat: open the Control UI (no channel setup needed). Run
|
|
35
|
+
`nodmix dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
|
|
36
|
+
</Info>
|
|
37
|
+
|
|
38
|
+
To reconfigure later:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
nodmix configure
|
|
42
|
+
nodmix agents add <name>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
<Note>
|
|
46
|
+
`--json` does not imply non-interactive mode. For scripts, use `--non-interactive`.
|
|
47
|
+
</Note>
|
|
48
|
+
|
|
49
|
+
<Tip>
|
|
50
|
+
CLI onboarding includes a web search step where you can pick a provider
|
|
51
|
+
such as Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search,
|
|
52
|
+
Ollama Web Search, Perplexity, SearXNG, or Tavily. Some providers require an
|
|
53
|
+
API key, while others are key-free. You can also configure this later with
|
|
54
|
+
`nodmix configure --section web`. Docs: [Web tools](/tools/web).
|
|
55
|
+
</Tip>
|
|
56
|
+
|
|
57
|
+
## QuickStart vs Advanced
|
|
58
|
+
|
|
59
|
+
Onboarding starts with **QuickStart** (defaults) vs **Advanced** (full control).
|
|
60
|
+
|
|
61
|
+
<Tabs>
|
|
62
|
+
<Tab title="QuickStart (defaults)">
|
|
63
|
+
- Local gateway (loopback)
|
|
64
|
+
- Workspace default (or existing workspace)
|
|
65
|
+
- Gateway port **18789**
|
|
66
|
+
- Gateway auth **Token** (auto-generated, even on loopback)
|
|
67
|
+
- Tool policy default for new local setups: `tools.profile: "coding"` (existing explicit profile is preserved)
|
|
68
|
+
- DM isolation default: local onboarding writes `session.dmScope: "per-channel-peer"` when unset. Details: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals)
|
|
69
|
+
- Tailscale exposure **Off**
|
|
70
|
+
- Telegram + WhatsApp DMs default to **allowlist** (you'll be prompted for your phone number)
|
|
71
|
+
|
|
72
|
+
</Tab>
|
|
73
|
+
<Tab title="Advanced (full control)">
|
|
74
|
+
- Exposes every step (mode, workspace, gateway, channels, daemon, skills).
|
|
75
|
+
|
|
76
|
+
</Tab>
|
|
77
|
+
</Tabs>
|
|
78
|
+
|
|
79
|
+
## What onboarding configures
|
|
80
|
+
|
|
81
|
+
**Local mode (default)** walks you through these steps:
|
|
82
|
+
|
|
83
|
+
1. **Model/Auth** — choose any supported provider/auth flow (API key, OAuth, or provider-specific manual auth), including Custom Provider
|
|
84
|
+
(OpenAI-compatible, Anthropic-compatible, or Unknown auto-detect). Pick a default model.
|
|
85
|
+
Security note: if this agent will run tools or process webhook/hooks content, prefer the strongest latest-generation model available and keep tool policy strict. Weaker/older tiers are easier to prompt-inject.
|
|
86
|
+
For non-interactive runs, `--secret-input-mode ref` stores env-backed refs in auth profiles instead of plaintext API key values.
|
|
87
|
+
In non-interactive `ref` mode, the provider env var must be set; passing inline key flags without that env var fails fast.
|
|
88
|
+
In interactive runs, choosing secret reference mode lets you point at either an environment variable or a configured provider ref (`file` or `exec`), with a fast preflight validation before saving.
|
|
89
|
+
For Anthropic, interactive onboarding/configure offers **Anthropic Claude CLI** as the preferred local path and **Anthropic API key** as the recommended production path. Anthropic setup-token also remains available as a supported token-auth path.
|
|
90
|
+
2. **Workspace** — Location for agent files (default `~/.nodmix/workspace`). Seeds bootstrap files.
|
|
91
|
+
3. **Gateway** — Port, bind address, auth mode, Tailscale exposure.
|
|
92
|
+
In interactive token mode, choose default plaintext token storage or opt into SecretRef.
|
|
93
|
+
Non-interactive token SecretRef path: `--gateway-token-ref-env <ENV_VAR>`.
|
|
94
|
+
4. **Channels** — built-in and official plugin chat channels such as iMessage, Discord, Feishu, Google Chat, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp, and more.
|
|
95
|
+
5. **Daemon** — Installs a LaunchAgent (macOS), systemd user unit (Linux/WSL2), or native Windows Scheduled Task with per-user Startup-folder fallback.
|
|
96
|
+
If token auth requires a token and `gateway.auth.token` is SecretRef-managed, daemon install validates it but does not persist the resolved token into supervisor service environment metadata.
|
|
97
|
+
If token auth requires a token and the configured token SecretRef is unresolved, daemon install is blocked with actionable guidance.
|
|
98
|
+
If both `gateway.auth.token` and `gateway.auth.password` are configured and `gateway.auth.mode` is unset, daemon install is blocked until mode is set explicitly.
|
|
99
|
+
6. **Health check** — Starts the Gateway and verifies it's running.
|
|
100
|
+
7. **Skills** — Installs recommended skills and optional dependencies.
|
|
101
|
+
|
|
102
|
+
<Note>
|
|
103
|
+
Re-running onboarding does **not** wipe anything unless you explicitly choose **Reset** (or pass `--reset`).
|
|
104
|
+
CLI `--reset` defaults to config, credentials, and sessions; use `--reset-scope full` to include workspace.
|
|
105
|
+
If the config is invalid or contains legacy keys, onboarding asks you to run `nodmix doctor` first.
|
|
106
|
+
</Note>
|
|
107
|
+
|
|
108
|
+
**Remote mode** only configures the local client to connect to a Gateway elsewhere.
|
|
109
|
+
It does **not** install or change anything on the remote host.
|
|
110
|
+
|
|
111
|
+
## Add another agent
|
|
112
|
+
|
|
113
|
+
Use `nodmix agents add <name>` to create a separate agent with its own workspace,
|
|
114
|
+
sessions, and auth profiles. Running without `--workspace` launches onboarding.
|
|
115
|
+
|
|
116
|
+
What it sets:
|
|
117
|
+
|
|
118
|
+
- `agents.list[].name`
|
|
119
|
+
- `agents.list[].workspace`
|
|
120
|
+
- `agents.list[].agentDir`
|
|
121
|
+
|
|
122
|
+
Notes:
|
|
123
|
+
|
|
124
|
+
- Default workspaces follow `~/.nodmix/workspace-<agentId>`.
|
|
125
|
+
- Add `bindings` to route inbound messages (onboarding can do this).
|
|
126
|
+
- Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
|
|
127
|
+
|
|
128
|
+
## Full reference
|
|
129
|
+
|
|
130
|
+
For detailed step-by-step breakdowns and config outputs, see
|
|
131
|
+
[CLI Setup Reference](/start/wizard-cli-reference).
|
|
132
|
+
For non-interactive examples, see [CLI Automation](/start/wizard-cli-automation).
|
|
133
|
+
For the deeper technical reference, including RPC details, see
|
|
134
|
+
[Onboarding Reference](/reference/wizard).
|
|
135
|
+
|
|
136
|
+
## Related docs
|
|
137
|
+
|
|
138
|
+
- CLI command reference: [`nodmix onboard`](/cli/onboard)
|
|
139
|
+
- Onboarding overview: [Onboarding Overview](/start/onboarding-overview)
|
|
140
|
+
- macOS app onboarding: [Onboarding](/start/onboarding)
|
|
141
|
+
- Agent first-run ritual: [Agent Bootstrapping](/start/bootstrapping)
|
package/docs/style.css
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
#content > h1:first-of-type {
|
|
2
|
+
display: none !important;
|
|
3
|
+
}
|
|
4
|
+
|
|
5
|
+
.nav-tabs {
|
|
6
|
+
position: relative;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
.nav-tabs-item > div {
|
|
10
|
+
opacity: 0;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
.nav-tabs-underline {
|
|
14
|
+
position: absolute;
|
|
15
|
+
left: 0;
|
|
16
|
+
bottom: 0;
|
|
17
|
+
height: 1.5px;
|
|
18
|
+
width: var(--nav-tab-underline-width, 0);
|
|
19
|
+
transform: translateX(var(--nav-tab-underline-x, 0));
|
|
20
|
+
background-color: rgb(var(--primary));
|
|
21
|
+
border-radius: 999px;
|
|
22
|
+
pointer-events: none;
|
|
23
|
+
opacity: 0;
|
|
24
|
+
transition:
|
|
25
|
+
transform 260ms ease-in-out,
|
|
26
|
+
width 260ms ease-in-out,
|
|
27
|
+
opacity 160ms ease-in-out;
|
|
28
|
+
will-change: transform, width;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
html.dark .nav-tabs-underline {
|
|
32
|
+
background-color: rgb(var(--primary-light));
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
.nav-tabs-underline-ready .nav-tabs-underline {
|
|
36
|
+
opacity: 1;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
.showcase-hero {
|
|
40
|
+
display: grid;
|
|
41
|
+
gap: 18px;
|
|
42
|
+
margin: 8px 0 22px;
|
|
43
|
+
padding: clamp(18px, 3vw, 30px);
|
|
44
|
+
border: 1px solid color-mix(in oklab, rgb(var(--primary)) 24%, transparent);
|
|
45
|
+
border-radius: 8px;
|
|
46
|
+
background: color-mix(in oklab, rgb(var(--primary)) 5%, transparent);
|
|
47
|
+
box-shadow: 0 18px 48px -34px rgba(0, 0, 0, 0.45);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
.showcase-kicker {
|
|
51
|
+
margin: 0;
|
|
52
|
+
font-size: 12px;
|
|
53
|
+
font-weight: 700;
|
|
54
|
+
letter-spacing: 0.08em;
|
|
55
|
+
text-transform: uppercase;
|
|
56
|
+
opacity: 0.72;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
.showcase-lead {
|
|
60
|
+
margin: 0;
|
|
61
|
+
max-width: 48rem;
|
|
62
|
+
font-size: clamp(18px, 2vw, 23px);
|
|
63
|
+
line-height: 1.6;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
.showcase-actions,
|
|
67
|
+
.showcase-jump-links {
|
|
68
|
+
display: flex;
|
|
69
|
+
flex-wrap: wrap;
|
|
70
|
+
gap: 10px;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
.showcase-actions a,
|
|
74
|
+
.showcase-jump-links a {
|
|
75
|
+
display: inline-flex;
|
|
76
|
+
align-items: center;
|
|
77
|
+
justify-content: center;
|
|
78
|
+
min-height: 40px;
|
|
79
|
+
padding: 0 14px;
|
|
80
|
+
border: 1px solid color-mix(in oklab, rgb(var(--primary)) 24%, transparent);
|
|
81
|
+
border-bottom: 1px solid color-mix(in oklab, rgb(var(--primary)) 24%, transparent);
|
|
82
|
+
border-radius: 8px;
|
|
83
|
+
background: color-mix(in oklab, rgb(var(--primary)) 4%, transparent);
|
|
84
|
+
text-decoration: none;
|
|
85
|
+
transition:
|
|
86
|
+
transform 0.16s ease,
|
|
87
|
+
border-color 0.16s ease,
|
|
88
|
+
background 0.16s ease;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
.showcase-actions a:first-child {
|
|
92
|
+
background: color-mix(in oklab, rgb(var(--primary)) 12%, transparent);
|
|
93
|
+
border-color: color-mix(in oklab, rgb(var(--primary)) 36%, transparent);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
.showcase-actions a:hover,
|
|
97
|
+
.showcase-jump-links a:hover {
|
|
98
|
+
transform: translateY(-1px);
|
|
99
|
+
border-color: color-mix(in oklab, rgb(var(--primary)) 46%, transparent);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
.showcase-highlights {
|
|
103
|
+
display: grid;
|
|
104
|
+
grid-template-columns: repeat(3, minmax(0, 1fr));
|
|
105
|
+
gap: 12px;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
.showcase-highlight,
|
|
109
|
+
.showcase-video-card {
|
|
110
|
+
border: 1px solid color-mix(in oklab, rgb(var(--primary)) 18%, transparent);
|
|
111
|
+
border-radius: 8px;
|
|
112
|
+
background: color-mix(in oklab, rgb(var(--primary)) 3%, transparent);
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
.showcase-highlight {
|
|
116
|
+
padding: 14px;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
.showcase-highlight strong {
|
|
120
|
+
display: block;
|
|
121
|
+
margin-bottom: 6px;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
.showcase-highlight span,
|
|
125
|
+
.showcase-section-intro,
|
|
126
|
+
.showcase-video-card p {
|
|
127
|
+
opacity: 0.74;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
.showcase-jump-links {
|
|
131
|
+
margin: 18px 0 28px;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
.showcase-section-intro {
|
|
135
|
+
margin: 0 0 16px;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
.showcase-video-grid {
|
|
139
|
+
display: grid;
|
|
140
|
+
grid-template-columns: repeat(3, minmax(0, 1fr));
|
|
141
|
+
gap: 18px;
|
|
142
|
+
margin: 0 0 28px;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
.showcase-video-card {
|
|
146
|
+
padding: 14px;
|
|
147
|
+
box-shadow: 0 18px 44px -32px rgba(0, 0, 0, 0.48);
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
.showcase-video-card h3 {
|
|
151
|
+
margin: 0 0 8px;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
.showcase-video-card p {
|
|
155
|
+
margin: 0 0 12px;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
.showcase-video-card a {
|
|
159
|
+
border-bottom: 0;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
.showcase-video-shell {
|
|
163
|
+
position: relative;
|
|
164
|
+
margin-bottom: 14px;
|
|
165
|
+
padding-bottom: 56.25%;
|
|
166
|
+
overflow: hidden;
|
|
167
|
+
border-radius: 8px;
|
|
168
|
+
background: #0a0a0a;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
.showcase-video-shell iframe {
|
|
172
|
+
position: absolute;
|
|
173
|
+
inset: 0;
|
|
174
|
+
width: 100%;
|
|
175
|
+
height: 100%;
|
|
176
|
+
border: 0;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
@media (max-width: 960px) {
|
|
180
|
+
.showcase-highlights,
|
|
181
|
+
.showcase-video-grid {
|
|
182
|
+
grid-template-columns: 1fr;
|
|
183
|
+
}
|
|
184
|
+
}
|