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,433 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Generate and edit images via image_generate across OpenAI, Google, fal, MiniMax, ComfyUI, DeepInfra, OpenRouter, LiteLLM, xAI, Vydra"
|
|
3
|
+
read_when:
|
|
4
|
+
- Generating or editing images via the agent
|
|
5
|
+
- Configuring image-generation providers and models
|
|
6
|
+
- Understanding the image_generate tool parameters
|
|
7
|
+
title: "Image generation"
|
|
8
|
+
sidebarTitle: "Image generation"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
The `image_generate` tool lets the agent create and edit images using your
|
|
12
|
+
configured providers. In chat sessions, image generation runs asynchronously:
|
|
13
|
+
Nodmix records a background task, returns the task id immediately, and wakes
|
|
14
|
+
the agent when the provider finishes. The completion agent must send generated
|
|
15
|
+
images through the `message` tool; Nodmix does not auto-post a private final
|
|
16
|
+
reply as a fallback.
|
|
17
|
+
|
|
18
|
+
<Note>
|
|
19
|
+
The tool only appears when at least one image-generation provider is
|
|
20
|
+
available. If you do not see `image_generate` in your agent's tools,
|
|
21
|
+
configure `agents.defaults.imageGenerationModel`, set up a provider API key,
|
|
22
|
+
or sign in with OpenAI Codex OAuth.
|
|
23
|
+
</Note>
|
|
24
|
+
|
|
25
|
+
## Quick start
|
|
26
|
+
|
|
27
|
+
<Steps>
|
|
28
|
+
<Step title="Configure auth">
|
|
29
|
+
Set an API key for at least one provider (for example `OPENAI_API_KEY`,
|
|
30
|
+
`GEMINI_API_KEY`, `OPENROUTER_API_KEY`) or sign in with OpenAI Codex OAuth.
|
|
31
|
+
</Step>
|
|
32
|
+
<Step title="Pick a default model (optional)">
|
|
33
|
+
```json5
|
|
34
|
+
{
|
|
35
|
+
agents: {
|
|
36
|
+
defaults: {
|
|
37
|
+
imageGenerationModel: {
|
|
38
|
+
primary: "openai/gpt-image-2",
|
|
39
|
+
timeoutMs: 180_000,
|
|
40
|
+
},
|
|
41
|
+
},
|
|
42
|
+
},
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Codex OAuth uses the same `openai/gpt-image-2` model ref. When an
|
|
47
|
+
`openai-codex` OAuth profile is configured, Nodmix routes image
|
|
48
|
+
requests through that OAuth profile instead of first trying
|
|
49
|
+
`OPENAI_API_KEY`. Explicit `models.providers.openai` config (API key,
|
|
50
|
+
custom/Azure base URL) opts back into the direct OpenAI Images API
|
|
51
|
+
route.
|
|
52
|
+
|
|
53
|
+
</Step>
|
|
54
|
+
<Step title="Ask the agent">
|
|
55
|
+
_"Generate an image of a friendly robot mascot."_
|
|
56
|
+
|
|
57
|
+
The agent calls `image_generate` automatically. No tool allow-listing
|
|
58
|
+
needed - it is enabled by default when a provider is available. The tool
|
|
59
|
+
returns a background task id, then the completion agent sends the generated
|
|
60
|
+
attachment through the `message` tool when it is ready.
|
|
61
|
+
|
|
62
|
+
</Step>
|
|
63
|
+
</Steps>
|
|
64
|
+
|
|
65
|
+
<Warning>
|
|
66
|
+
For OpenAI-compatible LAN endpoints such as LocalAI, keep the custom
|
|
67
|
+
`models.providers.openai.baseUrl` and explicitly opt in with
|
|
68
|
+
`browser.ssrfPolicy.dangerouslyAllowPrivateNetwork: true`. Private and
|
|
69
|
+
internal image endpoints remain blocked by default.
|
|
70
|
+
</Warning>
|
|
71
|
+
|
|
72
|
+
## Common routes
|
|
73
|
+
|
|
74
|
+
| Goal | Model ref | Auth |
|
|
75
|
+
| ---------------------------------------------------- | -------------------------------------------------- | -------------------------------------- |
|
|
76
|
+
| OpenAI image generation with API billing | `openai/gpt-image-2` | `OPENAI_API_KEY` |
|
|
77
|
+
| OpenAI image generation with Codex subscription auth | `openai/gpt-image-2` | OpenAI Codex OAuth |
|
|
78
|
+
| OpenAI transparent-background PNG/WebP | `openai/gpt-image-1.5` | `OPENAI_API_KEY` or OpenAI Codex OAuth |
|
|
79
|
+
| DeepInfra image generation | `deepinfra/black-forest-labs/FLUX-1-schnell` | `DEEPINFRA_API_KEY` |
|
|
80
|
+
| OpenRouter image generation | `openrouter/google/gemini-3.1-flash-image-preview` | `OPENROUTER_API_KEY` |
|
|
81
|
+
| LiteLLM image generation | `litellm/gpt-image-2` | `LITELLM_API_KEY` |
|
|
82
|
+
| Google Gemini image generation | `google/gemini-3.1-flash-image-preview` | `GEMINI_API_KEY` or `GOOGLE_API_KEY` |
|
|
83
|
+
|
|
84
|
+
The same `image_generate` tool handles text-to-image and reference-image
|
|
85
|
+
editing. Use `image` for one reference or `images` for multiple references.
|
|
86
|
+
Provider-supported output hints such as `quality`, `outputFormat`, and
|
|
87
|
+
`background` are forwarded when available and reported as ignored when a
|
|
88
|
+
provider does not support them. Bundled transparent-background support is
|
|
89
|
+
OpenAI-specific; other providers may still preserve PNG alpha if their
|
|
90
|
+
backend emits it.
|
|
91
|
+
|
|
92
|
+
## Supported providers
|
|
93
|
+
|
|
94
|
+
| Provider | Default model | Edit support | Auth |
|
|
95
|
+
| ---------- | --------------------------------------- | ---------------------------------- | ----------------------------------------------------- |
|
|
96
|
+
| ComfyUI | `workflow` | Yes (1 image, workflow-configured) | `COMFY_API_KEY` or `COMFY_CLOUD_API_KEY` for cloud |
|
|
97
|
+
| DeepInfra | `black-forest-labs/FLUX-1-schnell` | Yes (1 image) | `DEEPINFRA_API_KEY` |
|
|
98
|
+
| fal | `fal-ai/flux/dev` | Yes (model-specific limits) | `FAL_KEY` |
|
|
99
|
+
| Google | `gemini-3.1-flash-image-preview` | Yes | `GEMINI_API_KEY` or `GOOGLE_API_KEY` |
|
|
100
|
+
| LiteLLM | `gpt-image-2` | Yes (up to 5 input images) | `LITELLM_API_KEY` |
|
|
101
|
+
| MiniMax | `image-01` | Yes (subject reference) | `MINIMAX_API_KEY` or MiniMax OAuth (`minimax-portal`) |
|
|
102
|
+
| OpenAI | `gpt-image-2` | Yes (up to 4 images) | `OPENAI_API_KEY` or OpenAI Codex OAuth |
|
|
103
|
+
| OpenRouter | `google/gemini-3.1-flash-image-preview` | Yes (up to 5 input images) | `OPENROUTER_API_KEY` |
|
|
104
|
+
| Vydra | `grok-imagine` | No | `VYDRA_API_KEY` |
|
|
105
|
+
| xAI | `grok-imagine-image` | Yes (up to 5 images) | `XAI_API_KEY` |
|
|
106
|
+
|
|
107
|
+
Use `action: "list"` to inspect available providers and models at runtime:
|
|
108
|
+
|
|
109
|
+
```text
|
|
110
|
+
/tool image_generate action=list
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Use `action: "status"` to inspect the active image-generation task for the
|
|
114
|
+
current session:
|
|
115
|
+
|
|
116
|
+
```text
|
|
117
|
+
/tool image_generate action=status
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Provider capabilities
|
|
121
|
+
|
|
122
|
+
| Capability | ComfyUI | DeepInfra | fal | Google | MiniMax | OpenAI | Vydra | xAI |
|
|
123
|
+
| --------------------- | ------------------ | --------- | ------------------------- | -------------- | --------------------- | -------------- | ----- | -------------- |
|
|
124
|
+
| Generate (max count) | Workflow-defined | 4 | 4 | 4 | 9 | 4 | 1 | 4 |
|
|
125
|
+
| Edit / reference | 1 image (workflow) | 1 image | Flux: 1; GPT: 10; NB2: 14 | Up to 5 images | 1 image (subject ref) | Up to 5 images | - | Up to 5 images |
|
|
126
|
+
| Size control | - | ✓ | ✓ | ✓ | - | Up to 4K | - | - |
|
|
127
|
+
| Aspect ratio | - | - | ✓ | ✓ | ✓ | - | - | ✓ |
|
|
128
|
+
| Resolution (1K/2K/4K) | - | - | ✓ | ✓ | - | - | - | 1K, 2K |
|
|
129
|
+
|
|
130
|
+
## Tool parameters
|
|
131
|
+
|
|
132
|
+
<ParamField path="prompt" type="string" required>
|
|
133
|
+
Image generation prompt. Required for `action: "generate"`.
|
|
134
|
+
</ParamField>
|
|
135
|
+
<ParamField path="action" type='"generate" | "status" | "list"' default="generate">
|
|
136
|
+
Use `"status"` to inspect the active session task or `"list"` to inspect
|
|
137
|
+
available providers and models at runtime.
|
|
138
|
+
</ParamField>
|
|
139
|
+
<ParamField path="model" type="string">
|
|
140
|
+
Provider/model override (e.g. `openai/gpt-image-2`). Use
|
|
141
|
+
`openai/gpt-image-1.5` for transparent OpenAI backgrounds.
|
|
142
|
+
</ParamField>
|
|
143
|
+
<ParamField path="image" type="string">
|
|
144
|
+
Single reference image path or URL for edit mode.
|
|
145
|
+
</ParamField>
|
|
146
|
+
<ParamField path="images" type="string[]">
|
|
147
|
+
Multiple reference images for edit mode (up to 5 on supporting providers).
|
|
148
|
+
</ParamField>
|
|
149
|
+
<ParamField path="size" type="string">
|
|
150
|
+
Size hint: `1024x1024`, `1536x1024`, `1024x1536`, `2048x2048`, `3840x2160`.
|
|
151
|
+
</ParamField>
|
|
152
|
+
<ParamField path="aspectRatio" type="string">
|
|
153
|
+
Aspect ratio: `1:1`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9`.
|
|
154
|
+
</ParamField>
|
|
155
|
+
<ParamField path="resolution" type='"1K" | "2K" | "4K"'>Resolution hint.</ParamField>
|
|
156
|
+
<ParamField path="quality" type='"low" | "medium" | "high" | "auto"'>
|
|
157
|
+
Quality hint when the provider supports it.
|
|
158
|
+
</ParamField>
|
|
159
|
+
<ParamField path="outputFormat" type='"png" | "jpeg" | "webp"'>
|
|
160
|
+
Output format hint when the provider supports it.
|
|
161
|
+
</ParamField>
|
|
162
|
+
<ParamField path="background" type='"transparent" | "opaque" | "auto"'>
|
|
163
|
+
Background hint when the provider supports it. Use `transparent` with
|
|
164
|
+
`outputFormat: "png"` or `"webp"` for transparency-capable providers.
|
|
165
|
+
</ParamField>
|
|
166
|
+
<ParamField path="count" type="number">Number of images to generate (1-4).</ParamField>
|
|
167
|
+
<ParamField path="timeoutMs" type="number">
|
|
168
|
+
Optional provider request timeout in milliseconds. When Codex calls
|
|
169
|
+
`image_generate` through dynamic tools, this per-call value still overrides
|
|
170
|
+
the configured default and is capped at 600000 ms.
|
|
171
|
+
</ParamField>
|
|
172
|
+
<ParamField path="filename" type="string">Output filename hint.</ParamField>
|
|
173
|
+
<ParamField path="openai" type="object">
|
|
174
|
+
OpenAI-only hints: `background`, `moderation`, `outputCompression`, and `user`.
|
|
175
|
+
</ParamField>
|
|
176
|
+
|
|
177
|
+
<Note>
|
|
178
|
+
Not all providers support all parameters. When a fallback provider supports a
|
|
179
|
+
nearby geometry option instead of the exact requested one, Nodmix remaps to
|
|
180
|
+
the closest supported size, aspect ratio, or resolution before submission.
|
|
181
|
+
Unsupported output hints are dropped for providers that do not declare
|
|
182
|
+
support and reported in the tool result. Tool results report the applied
|
|
183
|
+
settings; `details.normalization` captures any requested-to-applied
|
|
184
|
+
translation.
|
|
185
|
+
</Note>
|
|
186
|
+
|
|
187
|
+
## Configuration
|
|
188
|
+
|
|
189
|
+
### Model selection
|
|
190
|
+
|
|
191
|
+
```json5
|
|
192
|
+
{
|
|
193
|
+
agents: {
|
|
194
|
+
defaults: {
|
|
195
|
+
imageGenerationModel: {
|
|
196
|
+
primary: "openai/gpt-image-2",
|
|
197
|
+
timeoutMs: 180_000,
|
|
198
|
+
fallbacks: [
|
|
199
|
+
"openrouter/google/gemini-3.1-flash-image-preview",
|
|
200
|
+
"google/gemini-3.1-flash-image-preview",
|
|
201
|
+
"fal/fal-ai/flux/dev",
|
|
202
|
+
],
|
|
203
|
+
},
|
|
204
|
+
},
|
|
205
|
+
},
|
|
206
|
+
}
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Provider selection order
|
|
210
|
+
|
|
211
|
+
Nodmix tries providers in this order:
|
|
212
|
+
|
|
213
|
+
1. **`model` parameter** from the tool call (if the agent specifies one).
|
|
214
|
+
2. **`imageGenerationModel.primary`** from config.
|
|
215
|
+
3. **`imageGenerationModel.fallbacks`** in order.
|
|
216
|
+
4. **Auto-detection** - auth-backed provider defaults only:
|
|
217
|
+
- current default provider first;
|
|
218
|
+
- remaining registered image-generation providers in provider-id order.
|
|
219
|
+
|
|
220
|
+
If a provider fails (auth error, rate limit, etc.), the next configured
|
|
221
|
+
candidate is tried automatically. If all fail, the error includes details
|
|
222
|
+
from each attempt.
|
|
223
|
+
|
|
224
|
+
<AccordionGroup>
|
|
225
|
+
<Accordion title="Per-call model overrides are exact">
|
|
226
|
+
A per-call `model` override tries only that provider/model and does
|
|
227
|
+
not continue to configured primary/fallback or auto-detected providers.
|
|
228
|
+
</Accordion>
|
|
229
|
+
<Accordion title="Auto-detection is auth-aware">
|
|
230
|
+
A provider default only enters the candidate list when Nodmix can
|
|
231
|
+
actually authenticate that provider. Set
|
|
232
|
+
`agents.defaults.mediaGenerationAutoProviderFallback: false` to use only
|
|
233
|
+
explicit `model`, `primary`, and `fallbacks` entries.
|
|
234
|
+
</Accordion>
|
|
235
|
+
<Accordion title="Timeouts">
|
|
236
|
+
Set `agents.defaults.imageGenerationModel.timeoutMs` for slow image
|
|
237
|
+
backends. A per-call `timeoutMs` tool parameter overrides the configured
|
|
238
|
+
default. Google, OpenRouter, and xAI hosted image providers use 180 second
|
|
239
|
+
defaults; Azure OpenAI image generation uses 600 seconds. Codex dynamic-tool
|
|
240
|
+
calls use a 120 second `image_generate` bridge default and honor the same
|
|
241
|
+
timeout budget when configured, bounded by Nodmix's 600000 ms dynamic-tool
|
|
242
|
+
bridge maximum.
|
|
243
|
+
</Accordion>
|
|
244
|
+
<Accordion title="Inspect at runtime">
|
|
245
|
+
Use `action: "list"` to inspect the currently registered providers,
|
|
246
|
+
their default models, and auth env-var hints.
|
|
247
|
+
</Accordion>
|
|
248
|
+
</AccordionGroup>
|
|
249
|
+
|
|
250
|
+
### Image editing
|
|
251
|
+
|
|
252
|
+
OpenAI, OpenRouter, Google, DeepInfra, fal, MiniMax, ComfyUI, and xAI support editing
|
|
253
|
+
reference images. Pass a reference image path or URL:
|
|
254
|
+
|
|
255
|
+
```text
|
|
256
|
+
"Generate a watercolor version of this photo" + image: "/path/to/photo.jpg"
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
OpenAI, OpenRouter, Google, and xAI support up to 5 reference images via the
|
|
260
|
+
`images` parameter. fal supports 1 reference image for Flux image-to-image, up
|
|
261
|
+
to 10 for GPT Image 2 edits, and up to 14 for Nano Banana 2 edits. MiniMax and
|
|
262
|
+
ComfyUI support 1.
|
|
263
|
+
|
|
264
|
+
## Provider deep dives
|
|
265
|
+
|
|
266
|
+
<AccordionGroup>
|
|
267
|
+
<Accordion title="OpenAI gpt-image-2 (and gpt-image-1.5)">
|
|
268
|
+
OpenAI image generation defaults to `openai/gpt-image-2`. If an
|
|
269
|
+
`openai-codex` OAuth profile is configured, Nodmix reuses the same
|
|
270
|
+
OAuth profile used by Codex subscription chat models and sends the
|
|
271
|
+
image request through the Codex Responses backend. Legacy Codex base
|
|
272
|
+
URLs such as `https://chatgpt.com/backend-api` are canonicalized to
|
|
273
|
+
`https://chatgpt.com/backend-api/codex` for image requests. Nodmix
|
|
274
|
+
does **not** silently fall back to `OPENAI_API_KEY` for that request -
|
|
275
|
+
to force direct OpenAI Images API routing, configure
|
|
276
|
+
`models.providers.openai` explicitly with an API key, custom base URL,
|
|
277
|
+
or Azure endpoint.
|
|
278
|
+
|
|
279
|
+
The `openai/gpt-image-1.5`, `openai/gpt-image-1`, and
|
|
280
|
+
`openai/gpt-image-1-mini` models can still be selected explicitly. Use
|
|
281
|
+
`gpt-image-1.5` for transparent-background PNG/WebP output; the current
|
|
282
|
+
`gpt-image-2` API rejects `background: "transparent"`.
|
|
283
|
+
|
|
284
|
+
`gpt-image-2` supports both text-to-image generation and
|
|
285
|
+
reference-image editing through the same `image_generate` tool.
|
|
286
|
+
Nodmix forwards `prompt`, `count`, `size`, `quality`, `outputFormat`,
|
|
287
|
+
and reference images to OpenAI. OpenAI does **not** receive
|
|
288
|
+
`aspectRatio` or `resolution` directly; when possible Nodmix maps
|
|
289
|
+
those into a supported `size`, otherwise the tool reports them as
|
|
290
|
+
ignored overrides.
|
|
291
|
+
|
|
292
|
+
OpenAI-specific options live under the `openai` object:
|
|
293
|
+
|
|
294
|
+
```json
|
|
295
|
+
{
|
|
296
|
+
"quality": "low",
|
|
297
|
+
"outputFormat": "jpeg",
|
|
298
|
+
"openai": {
|
|
299
|
+
"background": "opaque",
|
|
300
|
+
"moderation": "low",
|
|
301
|
+
"outputCompression": 60,
|
|
302
|
+
"user": "end-user-42"
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
`openai.background` accepts `transparent`, `opaque`, or `auto`;
|
|
308
|
+
transparent outputs require `outputFormat` `png` or `webp` and a
|
|
309
|
+
transparency-capable OpenAI image model. Nodmix routes default
|
|
310
|
+
`gpt-image-2` transparent-background requests to `gpt-image-1.5`.
|
|
311
|
+
`openai.outputCompression` applies to JPEG/WebP outputs.
|
|
312
|
+
|
|
313
|
+
The top-level `background` hint is provider-neutral and currently maps
|
|
314
|
+
to the same OpenAI `background` request field when the OpenAI provider
|
|
315
|
+
is selected. Providers that do not declare background support return
|
|
316
|
+
it in `ignoredOverrides` instead of receiving the unsupported parameter.
|
|
317
|
+
|
|
318
|
+
To route OpenAI image generation through an Azure OpenAI deployment
|
|
319
|
+
instead of `api.openai.com`, see
|
|
320
|
+
[Azure OpenAI endpoints](/providers/openai#azure-openai-endpoints).
|
|
321
|
+
|
|
322
|
+
</Accordion>
|
|
323
|
+
<Accordion title="OpenRouter image models">
|
|
324
|
+
OpenRouter image generation uses the same `OPENROUTER_API_KEY` and
|
|
325
|
+
routes through OpenRouter's chat completions image API. Select
|
|
326
|
+
OpenRouter image models with the `openrouter/` prefix:
|
|
327
|
+
|
|
328
|
+
```json5
|
|
329
|
+
{
|
|
330
|
+
agents: {
|
|
331
|
+
defaults: {
|
|
332
|
+
imageGenerationModel: {
|
|
333
|
+
primary: "openrouter/google/gemini-3.1-flash-image-preview",
|
|
334
|
+
},
|
|
335
|
+
},
|
|
336
|
+
},
|
|
337
|
+
}
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
Nodmix forwards `prompt`, `count`, reference images, and
|
|
341
|
+
Gemini-compatible `aspectRatio` / `resolution` hints to OpenRouter.
|
|
342
|
+
Current built-in OpenRouter image model shortcuts include
|
|
343
|
+
`google/gemini-3.1-flash-image-preview`,
|
|
344
|
+
`google/gemini-3-pro-image-preview`, and `openai/gpt-5.4-image-2`. Use
|
|
345
|
+
`action: "list"` to see what your configured plugin exposes.
|
|
346
|
+
|
|
347
|
+
</Accordion>
|
|
348
|
+
<Accordion title="MiniMax dual-auth">
|
|
349
|
+
MiniMax image generation is available through both bundled MiniMax
|
|
350
|
+
auth paths:
|
|
351
|
+
|
|
352
|
+
- `minimax/image-01` for API-key setups
|
|
353
|
+
- `minimax-portal/image-01` for OAuth setups
|
|
354
|
+
|
|
355
|
+
</Accordion>
|
|
356
|
+
<Accordion title="xAI grok-imagine-image">
|
|
357
|
+
The bundled xAI provider uses `/v1/images/generations` for prompt-only
|
|
358
|
+
requests and `/v1/images/edits` when `image` or `images` is present.
|
|
359
|
+
|
|
360
|
+
- Models: `xai/grok-imagine-image`, `xai/grok-imagine-image-quality`
|
|
361
|
+
- Count: up to 4
|
|
362
|
+
- References: one `image` or up to five `images`
|
|
363
|
+
- Aspect ratios: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `2:3`, `3:2`
|
|
364
|
+
- Resolutions: `1K`, `2K`
|
|
365
|
+
- Outputs: returned as Nodmix-managed image attachments
|
|
366
|
+
|
|
367
|
+
Nodmix intentionally does not expose xAI-native `quality`, `mask`,
|
|
368
|
+
`user`, or extra native-only aspect ratios until those controls exist
|
|
369
|
+
in the shared cross-provider `image_generate` contract.
|
|
370
|
+
|
|
371
|
+
</Accordion>
|
|
372
|
+
</AccordionGroup>
|
|
373
|
+
|
|
374
|
+
## Examples
|
|
375
|
+
|
|
376
|
+
<Tabs>
|
|
377
|
+
<Tab title="Generate (4K landscape)">
|
|
378
|
+
```text
|
|
379
|
+
/tool image_generate action=generate model=openai/gpt-image-2 prompt="A clean editorial poster for Nodmix image generation" size=3840x2160 count=1
|
|
380
|
+
```
|
|
381
|
+
</Tab>
|
|
382
|
+
<Tab title="Generate (transparent PNG)">
|
|
383
|
+
```text
|
|
384
|
+
/tool image_generate action=generate model=openai/gpt-image-1.5 prompt="A simple red circle sticker on a transparent background" outputFormat=png background=transparent
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
Equivalent CLI:
|
|
388
|
+
|
|
389
|
+
```bash
|
|
390
|
+
nodmix infer image generate \
|
|
391
|
+
--model openai/gpt-image-1.5 \
|
|
392
|
+
--output-format png \
|
|
393
|
+
--background transparent \
|
|
394
|
+
--prompt "A simple red circle sticker on a transparent background" \
|
|
395
|
+
--json
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
</Tab>
|
|
399
|
+
<Tab title="Generate (two square)">
|
|
400
|
+
```text
|
|
401
|
+
/tool image_generate action=generate model=openai/gpt-image-2 prompt="Two visual directions for a calm productivity app icon" size=1024x1024 count=2
|
|
402
|
+
```
|
|
403
|
+
</Tab>
|
|
404
|
+
<Tab title="Edit (one reference)">
|
|
405
|
+
```text
|
|
406
|
+
/tool image_generate action=generate model=openai/gpt-image-2 prompt="Keep the subject, replace the background with a bright studio setup" image=/path/to/reference.png size=1024x1536
|
|
407
|
+
```
|
|
408
|
+
</Tab>
|
|
409
|
+
<Tab title="Edit (multiple references)">
|
|
410
|
+
```text
|
|
411
|
+
/tool image_generate action=generate model=openai/gpt-image-2 prompt="Combine the character identity from the first image with the color palette from the second" images='["/path/to/character.png","/path/to/palette.jpg"]' size=1536x1024
|
|
412
|
+
```
|
|
413
|
+
</Tab>
|
|
414
|
+
</Tabs>
|
|
415
|
+
|
|
416
|
+
The same `--output-format` and `--background` flags are available on
|
|
417
|
+
`nodmix infer image edit`; `--openai-background` remains as an
|
|
418
|
+
OpenAI-specific alias. Bundled providers other than OpenAI do not declare
|
|
419
|
+
explicit background control today, so `background: "transparent"` is reported
|
|
420
|
+
as ignored for them.
|
|
421
|
+
|
|
422
|
+
## Related
|
|
423
|
+
|
|
424
|
+
- [Tools overview](/tools) - all available agent tools
|
|
425
|
+
- [ComfyUI](/providers/comfy) - local ComfyUI and Comfy Cloud workflow setup
|
|
426
|
+
- [fal](/providers/fal) - fal image and video provider setup
|
|
427
|
+
- [Google (Gemini)](/providers/google) - Gemini image provider setup
|
|
428
|
+
- [MiniMax](/providers/minimax) - MiniMax image provider setup
|
|
429
|
+
- [OpenAI](/providers/openai) - OpenAI Images provider setup
|
|
430
|
+
- [Vydra](/providers/vydra) - Vydra image, video, and speech setup
|
|
431
|
+
- [xAI](/providers/xai) - Grok image, video, search, code execution, and TTS setup
|
|
432
|
+
- [Configuration reference](/gateway/config-agents#agent-defaults) - `imageGenerationModel` config
|
|
433
|
+
- [Models](/concepts/models) - model configuration and failover
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
---
|
|
2
|
+
doc-schema-version: 1
|
|
3
|
+
summary: "Nodmix tools, skills, and plugins overview: what agents can call and how to extend them"
|
|
4
|
+
read_when:
|
|
5
|
+
- You want to understand what tools Nodmix provides
|
|
6
|
+
- You are deciding between built-in tools, skills, and plugins
|
|
7
|
+
- You need the right docs entry point for tool policy, automation, or agent coordination
|
|
8
|
+
title: "Overview"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Use this page to choose the right Capabilities surface. **Tools** are callable
|
|
12
|
+
actions, **skills** teach agents how to work, and **plugins** add runtime
|
|
13
|
+
capabilities such as tools, providers, channels, hooks, and packaged skills.
|
|
14
|
+
|
|
15
|
+
This is an overview and routing page. For exhaustive tool policy, defaults,
|
|
16
|
+
group membership, provider restrictions, and configuration fields, use
|
|
17
|
+
[Tools and custom providers](/gateway/config-tools).
|
|
18
|
+
|
|
19
|
+
## Start here
|
|
20
|
+
|
|
21
|
+
For most agents, start with the built-in tool categories, then adjust policy
|
|
22
|
+
only when the agent should see fewer tools or needs explicit host access.
|
|
23
|
+
|
|
24
|
+
| If you need to... | Use this first | Then read |
|
|
25
|
+
| ------------------------------------------- | ---------------------------------------------- | ----------------------------------------------------------------------- |
|
|
26
|
+
| Let an agent act with existing capabilities | [Built-in tools](#built-in-tool-categories) | [Tool categories](#built-in-tool-categories) |
|
|
27
|
+
| Control what an agent can call | [Tool policy](#configure-access-and-approvals) | [Tools and custom providers](/gateway/config-tools) |
|
|
28
|
+
| Teach an agent a workflow | [Skills](#choose-tools-skills-or-plugins) | [Skills](/tools/skills) and [Creating skills](/tools/creating-skills) |
|
|
29
|
+
| Add a new integration or runtime surface | [Plugins](#extend-capabilities) | [Plugins](/tools/plugin) and [Build plugins](/plugins/building-plugins) |
|
|
30
|
+
| Run work later or in the background | [Automation](/automation) | [Automation overview](/automation) |
|
|
31
|
+
| Coordinate multiple agents or harnesses | [Sub-agents](/tools/subagents) | [ACP agents](/tools/acp-agents) and [Agent send](/tools/agent-send) |
|
|
32
|
+
| Search a large PI tool catalog | [Tool Search](/tools/tool-search) | [Tool Search](/tools/tool-search) |
|
|
33
|
+
|
|
34
|
+
## Choose tools, skills, or plugins
|
|
35
|
+
|
|
36
|
+
<Steps>
|
|
37
|
+
<Step title="Use a tool when the agent needs to act">
|
|
38
|
+
A tool is a typed function the agent can call, such as `exec`, `browser`,
|
|
39
|
+
`web_search`, `message`, or `image_generate`. Use tools when the agent
|
|
40
|
+
needs to read data, change files, send messages, call a provider, or operate
|
|
41
|
+
another system. Visible tools are sent to the model as structured function
|
|
42
|
+
definitions.
|
|
43
|
+
|
|
44
|
+
The model only sees tools that survive the active profile, allow/deny
|
|
45
|
+
policy, provider restrictions, sandbox state, channel permissions, and
|
|
46
|
+
plugin availability.
|
|
47
|
+
|
|
48
|
+
</Step>
|
|
49
|
+
|
|
50
|
+
<Step title="Use a skill when the agent needs instructions">
|
|
51
|
+
A skill is a `SKILL.md` instruction pack loaded into the agent prompt. Use a
|
|
52
|
+
skill when the agent already has the tools it needs, but needs a repeatable
|
|
53
|
+
workflow, review rubric, command sequence, or operating constraint.
|
|
54
|
+
|
|
55
|
+
Skills can live in a workspace, shared skill directory, managed Nodmix
|
|
56
|
+
skill root, or plugin package.
|
|
57
|
+
|
|
58
|
+
[Skills](/tools/skills) | [Creating skills](/tools/creating-skills) | [Skills config](/tools/skills-config)
|
|
59
|
+
|
|
60
|
+
</Step>
|
|
61
|
+
|
|
62
|
+
<Step title="Use a plugin when Nodmix needs a new capability">
|
|
63
|
+
A plugin can add tools, skills, channels, model providers, speech, realtime
|
|
64
|
+
voice, media generation, web search, web fetch, hooks, and other runtime
|
|
65
|
+
capabilities. Use a plugin when the capability has code, credentials,
|
|
66
|
+
lifecycle hooks, manifest metadata, or installable packaging. Existing
|
|
67
|
+
plugins can be installed from ClawHub, npm, git, local directories, or
|
|
68
|
+
archives.
|
|
69
|
+
|
|
70
|
+
[Install and configure plugins](/tools/plugin) | [Build plugins](/plugins/building-plugins) | [Plugin SDK](/plugins/sdk-overview)
|
|
71
|
+
|
|
72
|
+
</Step>
|
|
73
|
+
</Steps>
|
|
74
|
+
|
|
75
|
+
## Built-in tool categories
|
|
76
|
+
|
|
77
|
+
The table lists representative tools so you can recognize the surface. It is
|
|
78
|
+
not the full policy reference. For exact groups, defaults, and allow/deny
|
|
79
|
+
semantics, use [Tools and custom providers](/gateway/config-tools).
|
|
80
|
+
|
|
81
|
+
| Category | Use when the agent needs to... | Representative tools | Read next |
|
|
82
|
+
| ---------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
83
|
+
| Runtime | Run commands, manage processes, or use provider-backed Python analysis | `exec`, `process`, `code_execution` | [Exec](/tools/exec), [Code execution](/tools/code-execution) |
|
|
84
|
+
| Files | Read and change workspace files | `read`, `write`, `edit`, `apply_patch` | [Apply patch](/tools/apply-patch) |
|
|
85
|
+
| Web | Search the web, search X posts, or fetch readable page content | `web_search`, `x_search`, `web_fetch` | [Web tools](/tools/web), [Web fetch](/tools/web-fetch) |
|
|
86
|
+
| Browser | Operate a browser session | `browser` | [Browser](/tools/browser) |
|
|
87
|
+
| Messaging and channels | Send replies or channel actions | `message` | [Agent send](/tools/agent-send) |
|
|
88
|
+
| Sessions and agents | Inspect sessions, delegate work, steer another run, or report status | `sessions_*`, `subagents`, `agents_list`, `session_status` | [Sub-agents](/tools/subagents), [Session tool](/concepts/session-tool) |
|
|
89
|
+
| Automation | Schedule work or respond to background events | `cron`, `heartbeat_respond` | [Automation](/automation) |
|
|
90
|
+
| Gateway and nodes | Inspect Gateway state or paired target devices | `gateway`, `nodes` | [Gateway configuration](/gateway/configuration), [Nodes](/nodes) |
|
|
91
|
+
| Media | Analyze, generate, or speak media | `image`, `image_generate`, `music_generate`, `video_generate`, `tts` | [Media overview](/tools/media-overview) |
|
|
92
|
+
| Large PI catalogs | Search and call many eligible tools without sending every schema to the model | `tool_search_code`, `tool_search`, `tool_describe` | [Tool Search](/tools/tool-search) |
|
|
93
|
+
|
|
94
|
+
<Note>
|
|
95
|
+
Tool Search is an experimental PI-agent surface. Codex harness runs use
|
|
96
|
+
Codex-native code mode, native tool search, deferred dynamic tools, and nested
|
|
97
|
+
tool calls instead of `tools.toolSearch`.
|
|
98
|
+
</Note>
|
|
99
|
+
|
|
100
|
+
## Plugin-provided tools
|
|
101
|
+
|
|
102
|
+
Plugins can register additional tools. Plugin authors wire tools through
|
|
103
|
+
`api.registerTool(...)` and the manifest's `contracts.tools`; use
|
|
104
|
+
[Plugin SDK](/plugins/sdk-overview) and [Plugin manifest](/plugins/manifest)
|
|
105
|
+
for contract details.
|
|
106
|
+
|
|
107
|
+
Common plugin-provided tools include:
|
|
108
|
+
|
|
109
|
+
- [Diffs](/tools/diffs) for rendering file and markdown diffs
|
|
110
|
+
- [LLM Task](/tools/llm-task) for JSON-only workflow steps
|
|
111
|
+
- [Lobster](/tools/lobster) for typed workflows with resumable approvals
|
|
112
|
+
- [Tokenjuice](/tools/tokenjuice) for compacting noisy `exec` and `bash` tool
|
|
113
|
+
output
|
|
114
|
+
- [Tool Search](/tools/tool-search) for discovering and calling large tool
|
|
115
|
+
catalogs without putting every schema in the prompt
|
|
116
|
+
- [Canvas](/plugins/reference/canvas) for node Canvas control and A2UI
|
|
117
|
+
rendering
|
|
118
|
+
|
|
119
|
+
## Configure access and approvals
|
|
120
|
+
|
|
121
|
+
Tool policy is enforced before the model call. If policy removes a tool, the
|
|
122
|
+
model does not receive that tool's schema for the turn. A run can lose tools
|
|
123
|
+
because of global config, per-agent config, channel policy, provider
|
|
124
|
+
restrictions, sandbox rules, channel/runtime policy, or plugin availability.
|
|
125
|
+
|
|
126
|
+
- [Tools and custom providers](/gateway/config-tools) documents tool profiles,
|
|
127
|
+
allow/deny lists, provider-specific restrictions, loop detection, and
|
|
128
|
+
provider-backed tool settings.
|
|
129
|
+
- [Exec approvals](/tools/exec-approvals) documents host command approval
|
|
130
|
+
policy.
|
|
131
|
+
- [Elevated exec](/tools/elevated) documents controlled execution outside the
|
|
132
|
+
sandbox.
|
|
133
|
+
- [Sandbox vs tool policy vs elevated](/gateway/sandbox-vs-tool-policy-vs-elevated) explains which layer controls file and process access.
|
|
134
|
+
- [Per-agent sandbox and tool restrictions](/tools/multi-agent-sandbox-tools)
|
|
135
|
+
documents agent-specific restrictions for delegated runs.
|
|
136
|
+
|
|
137
|
+
## Extend capabilities
|
|
138
|
+
|
|
139
|
+
Choose the extension path by the job you need Nodmix to do:
|
|
140
|
+
|
|
141
|
+
- Install or manage an existing plugin with [Plugins](/tools/plugin).
|
|
142
|
+
- Build a new integration, provider, channel, tool, or hook with
|
|
143
|
+
[Build plugins](/plugins/building-plugins).
|
|
144
|
+
- Add or tune reusable agent instructions with [Skills](/tools/skills) and
|
|
145
|
+
[Creating skills](/tools/creating-skills).
|
|
146
|
+
- Package reusable workflow material with
|
|
147
|
+
[Skill workshop](/plugins/skill-workshop) when the workflow belongs in a
|
|
148
|
+
plugin-distributed skill bundle.
|
|
149
|
+
- Use [Plugin SDK](/plugins/sdk-overview) and [Plugin manifest](/plugins/manifest) when you need implementation contracts.
|
|
150
|
+
|
|
151
|
+
## Troubleshoot missing tools
|
|
152
|
+
|
|
153
|
+
If the model cannot see or call a tool, start with the effective policy for the
|
|
154
|
+
current turn:
|
|
155
|
+
|
|
156
|
+
1. Check the active profile, `tools.allow`, and `tools.deny` in
|
|
157
|
+
[Tools and custom providers](/gateway/config-tools).
|
|
158
|
+
2. Check provider-specific restrictions in
|
|
159
|
+
[Tools and custom providers](/gateway/config-tools) and confirm the selected
|
|
160
|
+
[model provider](/concepts/model-providers) supports the tool shape.
|
|
161
|
+
3. Check channel permissions, sandbox state, and elevated access with
|
|
162
|
+
[Sandbox vs tool policy vs elevated](/gateway/sandbox-vs-tool-policy-vs-elevated) and [Elevated exec](/tools/elevated).
|
|
163
|
+
4. Check whether the owning plugin is installed and enabled in
|
|
164
|
+
[Plugins](/tools/plugin).
|
|
165
|
+
5. For delegated runs, check per-agent restrictions in
|
|
166
|
+
[Per-agent sandbox and tool restrictions](/tools/multi-agent-sandbox-tools).
|
|
167
|
+
6. For large PI catalogs, confirm whether the run uses direct tool exposure or
|
|
168
|
+
[Tool Search](/tools/tool-search).
|
|
169
|
+
|
|
170
|
+
## Related
|
|
171
|
+
|
|
172
|
+
- [Automation](/automation) for cron, tasks, heartbeat, commitments, hooks, standing orders, and Task Flow
|
|
173
|
+
- [Agents](/concepts/agent) for the agent model, sessions, memory, and multi-agent coordination
|
|
174
|
+
- [Tools and custom providers](/gateway/config-tools) for the canonical tool policy reference
|
|
175
|
+
- [Plugins](/tools/plugin) for plugin installation and management
|
|
176
|
+
- [Plugin SDK](/plugins/sdk-overview) for plugin author reference
|
|
177
|
+
- [Skills](/tools/skills) for skill load order, gating, and config
|
|
178
|
+
- [Tool Search](/tools/tool-search) for compact PI tool catalog discovery
|