vilvona 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12331 -0
- package/LICENSE +24 -0
- package/README.md +314 -0
- package/THIRD_PARTY_NOTICES.md +37 -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 +82 -0
- package/docs/.i18n/glossary.de.json +82 -0
- package/docs/.i18n/glossary.es.json +82 -0
- package/docs/.i18n/glossary.fa.json +82 -0
- package/docs/.i18n/glossary.fr.json +82 -0
- package/docs/.i18n/glossary.id.json +82 -0
- package/docs/.i18n/glossary.it.json +82 -0
- package/docs/.i18n/glossary.ja-JP.json +102 -0
- package/docs/.i18n/glossary.ko.json +82 -0
- package/docs/.i18n/glossary.nl.json +82 -0
- package/docs/.i18n/glossary.pl.json +82 -0
- package/docs/.i18n/glossary.pt-BR.json +82 -0
- package/docs/.i18n/glossary.th.json +82 -0
- package/docs/.i18n/glossary.tr.json +82 -0
- package/docs/.i18n/glossary.uk.json +82 -0
- package/docs/.i18n/glossary.vi.json +82 -0
- package/docs/.i18n/glossary.zh-CN.json +1182 -0
- package/docs/.i18n/glossary.zh-TW.json +162 -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 +552 -0
- package/docs/AGENTS.md +36 -0
- package/docs/agent-runtime-architecture.md +48 -0
- package/docs/announcements/bluebubbles-imessage.md +79 -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 +569 -0
- package/docs/automation/cron-vs-heartbeat.md +11 -0
- package/docs/automation/gmail-pubsub.md +11 -0
- package/docs/automation/hooks.md +387 -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 +146 -0
- package/docs/channels/discord.md +1758 -0
- package/docs/channels/feishu.md +654 -0
- package/docs/channels/googlechat.md +286 -0
- package/docs/channels/group-messages.md +95 -0
- package/docs/channels/groups.md +610 -0
- package/docs/channels/imessage-from-bluebubbles.md +259 -0
- package/docs/channels/imessage.md +864 -0
- package/docs/channels/index.md +65 -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 +375 -0
- package/docs/channels/matrix-presentation.md +77 -0
- package/docs/channels/matrix-push-rules.md +150 -0
- package/docs/channels/matrix.md +935 -0
- package/docs/channels/mattermost.md +542 -0
- package/docs/channels/msteams.md +1097 -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 +317 -0
- package/docs/channels/signal.md +417 -0
- package/docs/channels/slack.md +1623 -0
- package/docs/channels/sms.md +380 -0
- package/docs/channels/synology-chat.md +187 -0
- package/docs/channels/telegram.md +1121 -0
- package/docs/channels/tlon.md +296 -0
- package/docs/channels/troubleshooting.md +162 -0
- package/docs/channels/twitch.md +431 -0
- package/docs/channels/wechat.md +171 -0
- package/docs/channels/whatsapp.md +796 -0
- package/docs/channels/yuanbao.md +416 -0
- package/docs/channels/zalo.md +253 -0
- package/docs/channels/zalouser.md +217 -0
- package/docs/ci.md +665 -0
- package/docs/clawhub/cli.md +82 -0
- package/docs/clawhub/publishing.md +96 -0
- package/docs/cli/acp.md +370 -0
- package/docs/cli/agent.md +109 -0
- package/docs/cli/agents.md +253 -0
- package/docs/cli/approvals.md +193 -0
- package/docs/cli/backup.md +98 -0
- package/docs/cli/browser.md +322 -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 +337 -0
- package/docs/cli/cron.md +344 -0
- package/docs/cli/daemon.md +67 -0
- package/docs/cli/dashboard.md +33 -0
- package/docs/cli/devices.md +240 -0
- package/docs/cli/directory.md +68 -0
- package/docs/cli/dns.md +53 -0
- package/docs/cli/docs.md +63 -0
- package/docs/cli/doctor.md +254 -0
- package/docs/cli/flows.md +52 -0
- package/docs/cli/gateway.md +572 -0
- package/docs/cli/health.md +43 -0
- package/docs/cli/hooks.md +345 -0
- package/docs/cli/index.md +406 -0
- package/docs/cli/infer.md +364 -0
- package/docs/cli/logs.md +68 -0
- package/docs/cli/mcp.md +851 -0
- package/docs/cli/memory.md +183 -0
- package/docs/cli/message.md +317 -0
- package/docs/cli/migrate.md +334 -0
- package/docs/cli/models.md +239 -0
- package/docs/cli/node.md +178 -0
- package/docs/cli/nodes.md +76 -0
- package/docs/cli/onboard.md +251 -0
- package/docs/cli/pairing.md +77 -0
- package/docs/cli/path.md +511 -0
- package/docs/cli/plugins.md +480 -0
- package/docs/cli/policy.md +929 -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 +135 -0
- package/docs/cli/sessions.md +178 -0
- package/docs/cli/setup.md +60 -0
- package/docs/cli/skills.md +156 -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/transcripts.md +151 -0
- package/docs/cli/tui.md +92 -0
- package/docs/cli/uninstall.md +45 -0
- package/docs/cli/update.md +283 -0
- package/docs/cli/voicecall.md +204 -0
- package/docs/cli/webhooks.md +117 -0
- package/docs/cli/wiki.md +256 -0
- package/docs/cli/workboard.md +228 -0
- package/docs/concepts/active-memory.md +856 -0
- package/docs/concepts/agent-loop.md +185 -0
- package/docs/concepts/agent-runtimes.md +276 -0
- package/docs/concepts/agent-workspace.md +230 -0
- package/docs/concepts/agent.md +142 -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 +347 -0
- package/docs/concepts/context.md +199 -0
- package/docs/concepts/delegate-architecture.md +319 -0
- package/docs/concepts/dreaming.md +279 -0
- package/docs/concepts/experimental-features.md +111 -0
- package/docs/concepts/features.md +91 -0
- package/docs/concepts/mantis-slack-desktop-runbook.md +231 -0
- package/docs/concepts/mantis.md +744 -0
- package/docs/concepts/markdown-formatting.md +139 -0
- package/docs/concepts/memory-builtin.md +151 -0
- package/docs/concepts/memory-honcho.md +144 -0
- package/docs/concepts/memory-qmd.md +277 -0
- package/docs/concepts/memory-search.md +175 -0
- package/docs/concepts/memory.md +299 -0
- package/docs/concepts/message-lifecycle-refactor.md +1126 -0
- package/docs/concepts/messages.md +216 -0
- package/docs/concepts/model-failover.md +405 -0
- package/docs/concepts/model-providers.md +719 -0
- package/docs/concepts/models.md +371 -0
- package/docs/concepts/multi-agent.md +625 -0
- package/docs/concepts/oauth.md +218 -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 +406 -0
- package/docs/concepts/qa-e2e-automation.md +979 -0
- package/docs/concepts/qa-matrix.md +139 -0
- package/docs/concepts/queue-steering.md +90 -0
- package/docs/concepts/queue.md +136 -0
- package/docs/concepts/retry.md +86 -0
- package/docs/concepts/session-pruning.md +104 -0
- package/docs/concepts/session-tool.md +201 -0
- package/docs/concepts/session.md +164 -0
- package/docs/concepts/soul.md +116 -0
- package/docs/concepts/streaming.md +258 -0
- package/docs/concepts/system-prompt.md +330 -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 +72 -0
- package/docs/date-time.md +126 -0
- package/docs/debug/node-issue.md +90 -0
- package/docs/diagnostics/flags.md +182 -0
- package/docs/docs.json +1885 -0
- package/docs/gateway/authentication.md +286 -0
- package/docs/gateway/background-process.md +147 -0
- package/docs/gateway/bonjour.md +303 -0
- package/docs/gateway/bridge-protocol.md +97 -0
- package/docs/gateway/cli-backends.md +463 -0
- package/docs/gateway/config-agents.md +1525 -0
- package/docs/gateway/config-channels.md +942 -0
- package/docs/gateway/config-tools.md +806 -0
- package/docs/gateway/configuration-examples.md +706 -0
- package/docs/gateway/configuration-reference.md +1449 -0
- package/docs/gateway/configuration.md +748 -0
- package/docs/gateway/diagnostics.md +213 -0
- package/docs/gateway/discovery.md +154 -0
- package/docs/gateway/doctor.md +576 -0
- package/docs/gateway/external-apps.md +86 -0
- package/docs/gateway/gateway-lock.md +37 -0
- package/docs/gateway/health.md +73 -0
- package/docs/gateway/heartbeat.md +498 -0
- package/docs/gateway/index.md +385 -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 +379 -0
- package/docs/gateway/openresponses-http-api.md +349 -0
- package/docs/gateway/openshell.md +316 -0
- package/docs/gateway/opentelemetry.md +440 -0
- package/docs/gateway/operator-scopes.md +119 -0
- package/docs/gateway/pairing.md +207 -0
- package/docs/gateway/prometheus.md +249 -0
- package/docs/gateway/protocol.md +839 -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 +148 -0
- package/docs/gateway/sandboxing.md +546 -0
- package/docs/gateway/secrets-plan-contract.md +159 -0
- package/docs/gateway/secrets.md +805 -0
- package/docs/gateway/security/audit-checks.md +127 -0
- package/docs/gateway/security/exposure-runbook.md +212 -0
- package/docs/gateway/security/index.md +1344 -0
- package/docs/gateway/security/secure-file-operations.md +76 -0
- package/docs/gateway/security/shrinkwrap.md +111 -0
- package/docs/gateway/tailscale.md +180 -0
- package/docs/gateway/tools-invoke-http-api.md +175 -0
- package/docs/gateway/troubleshooting.md +881 -0
- package/docs/gateway/trusted-proxy-auth.md +483 -0
- package/docs/help/debugging.md +341 -0
- package/docs/help/environment.md +240 -0
- package/docs/help/faq-first-run.md +872 -0
- package/docs/help/faq-models.md +557 -0
- package/docs/help/faq.md +2115 -0
- package/docs/help/index.md +39 -0
- package/docs/help/scripts.md +56 -0
- package/docs/help/testing-live.md +592 -0
- package/docs/help/testing-updates-plugins.md +299 -0
- package/docs/help/testing.md +977 -0
- package/docs/help/troubleshooting.md +500 -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 +148 -0
- package/docs/install/digitalocean.md +174 -0
- package/docs/install/docker-vm-runtime.md +154 -0
- package/docs/install/docker.md +564 -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 +236 -0
- package/docs/install/installer.md +447 -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 +178 -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 +216 -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 +140 -0
- package/docs/install/updating.md +284 -0
- package/docs/install/upstash.md +96 -0
- package/docs/logging.md +322 -0
- package/docs/maturity-scores.yaml +5361 -0
- package/docs/nav-tabs-underline.js +104 -0
- package/docs/network.md +72 -0
- package/docs/nodes/audio.md +216 -0
- package/docs/nodes/camera.md +166 -0
- package/docs/nodes/images.md +77 -0
- package/docs/nodes/index.md +444 -0
- package/docs/nodes/location-command.md +102 -0
- package/docs/nodes/media-understanding.md +495 -0
- package/docs/nodes/talk.md +160 -0
- package/docs/nodes/troubleshooting.md +123 -0
- package/docs/nodes/voicewake.md +93 -0
- package/docs/openclaw-agent-runtime.md +82 -0
- package/docs/perplexity.md +11 -0
- package/docs/plan/codex-context-engine-harness.md +624 -0
- package/docs/plan/ui-channels.md +284 -0
- package/docs/platforms/android.md +286 -0
- package/docs/platforms/digitalocean.md +12 -0
- package/docs/platforms/easyrunner.md +109 -0
- package/docs/platforms/index.md +65 -0
- package/docs/platforms/ios.md +287 -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 +96 -0
- package/docs/platforms/mac/permissions.md +73 -0
- package/docs/platforms/mac/remote.md +123 -0
- package/docs/platforms/mac/signing.md +52 -0
- package/docs/platforms/mac/skills.md +45 -0
- package/docs/platforms/mac/voice-overlay.md +66 -0
- package/docs/platforms/mac/voicewake.md +79 -0
- package/docs/platforms/mac/webchat.md +54 -0
- package/docs/platforms/mac/xpc.md +66 -0
- package/docs/platforms/macos.md +228 -0
- package/docs/platforms/oracle.md +12 -0
- package/docs/platforms/raspberry-pi.md +13 -0
- package/docs/platforms/windows.md +304 -0
- package/docs/plugins/adding-capabilities.md +146 -0
- package/docs/plugins/admin-http-rpc.md +216 -0
- package/docs/plugins/agent-tools.md +13 -0
- package/docs/plugins/architecture-internals.md +1203 -0
- package/docs/plugins/architecture.md +483 -0
- package/docs/plugins/building-extensions.md +13 -0
- package/docs/plugins/building-plugins.md +343 -0
- package/docs/plugins/bundles.md +310 -0
- package/docs/plugins/cli-backend-plugins.md +328 -0
- package/docs/plugins/codex-computer-use.md +297 -0
- package/docs/plugins/codex-harness-reference.md +480 -0
- package/docs/plugins/codex-harness-runtime.md +268 -0
- package/docs/plugins/codex-harness.md +800 -0
- package/docs/plugins/codex-native-plugins.md +280 -0
- package/docs/plugins/community.md +77 -0
- package/docs/plugins/compatibility.md +198 -0
- package/docs/plugins/copilot.md +355 -0
- package/docs/plugins/dependency-resolution.md +176 -0
- package/docs/plugins/google-meet.md +1737 -0
- package/docs/plugins/hooks.md +525 -0
- package/docs/plugins/install-overrides.md +80 -0
- package/docs/plugins/llama-cpp.md +58 -0
- package/docs/plugins/manage-plugins.md +214 -0
- package/docs/plugins/manifest.md +1468 -0
- package/docs/plugins/memory-lancedb.md +385 -0
- package/docs/plugins/memory-wiki.md +529 -0
- package/docs/plugins/message-presentation.md +487 -0
- package/docs/plugins/oc-path.md +166 -0
- package/docs/plugins/plugin-inventory.md +318 -0
- package/docs/plugins/plugin-permission-requests.md +193 -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 +29 -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-supervisor.md +27 -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/copilot.md +23 -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-language-pack.md +31 -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/gmi.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/llama-cpp.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 +113 -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/novita.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 +24 -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/pixverse.md +23 -0
- package/docs/plugins/reference/policy.md +79 -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 +24 -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/slack.md +23 -0
- package/docs/plugins/reference/sms.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/workboard.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 +19 -0
- package/docs/plugins/sdk-agent-harness.md +339 -0
- package/docs/plugins/sdk-channel-inbound.md +70 -0
- package/docs/plugins/sdk-channel-ingress.md +137 -0
- package/docs/plugins/sdk-channel-message.md +18 -0
- package/docs/plugins/sdk-channel-outbound.md +113 -0
- package/docs/plugins/sdk-channel-plugins.md +770 -0
- package/docs/plugins/sdk-channel-turn.md +9 -0
- package/docs/plugins/sdk-entrypoints.md +344 -0
- package/docs/plugins/sdk-migration.md +1011 -0
- package/docs/plugins/sdk-overview.md +525 -0
- package/docs/plugins/sdk-provider-plugins.md +1019 -0
- package/docs/plugins/sdk-runtime.md +683 -0
- package/docs/plugins/sdk-setup.md +550 -0
- package/docs/plugins/sdk-subpaths.md +401 -0
- package/docs/plugins/sdk-testing.md +403 -0
- package/docs/plugins/tool-plugins.md +411 -0
- package/docs/plugins/voice-call.md +942 -0
- package/docs/plugins/webhooks.md +192 -0
- package/docs/plugins/workboard.md +402 -0
- package/docs/plugins/zalouser.md +86 -0
- package/docs/prose.md +191 -0
- package/docs/providers/alibaba.md +158 -0
- package/docs/providers/anthropic.md +386 -0
- package/docs/providers/arcee.md +144 -0
- package/docs/providers/azure-speech.md +119 -0
- package/docs/providers/bedrock-mantle.md +224 -0
- package/docs/providers/bedrock.md +433 -0
- package/docs/providers/cerebras.md +130 -0
- package/docs/providers/chutes.md +153 -0
- package/docs/providers/claude-max-api-proxy.md +191 -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 +92 -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 +240 -0
- package/docs/providers/fireworks.md +144 -0
- package/docs/providers/github-copilot.md +257 -0
- package/docs/providers/gmi.md +92 -0
- package/docs/providers/google.md +472 -0
- package/docs/providers/gradium.md +123 -0
- package/docs/providers/groq.md +171 -0
- package/docs/providers/huggingface.md +235 -0
- package/docs/providers/index.md +105 -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 +518 -0
- package/docs/providers/mistral.md +235 -0
- package/docs/providers/models.md +64 -0
- package/docs/providers/moonshot.md +413 -0
- package/docs/providers/novita.md +92 -0
- package/docs/providers/nvidia.md +208 -0
- package/docs/providers/ollama-cloud.md +115 -0
- package/docs/providers/ollama.md +1225 -0
- package/docs/providers/openai.md +1091 -0
- package/docs/providers/opencode-go.md +123 -0
- package/docs/providers/opencode.md +149 -0
- package/docs/providers/openrouter.md +390 -0
- package/docs/providers/perplexity-provider.md +123 -0
- package/docs/providers/pixverse.md +165 -0
- package/docs/providers/qianfan.md +132 -0
- package/docs/providers/qwen-oauth.md +115 -0
- package/docs/providers/qwen.md +364 -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 +140 -0
- package/docs/providers/venice.md +312 -0
- package/docs/providers/vercel-ai-gateway.md +128 -0
- package/docs/providers/vllm.md +407 -0
- package/docs/providers/volcengine.md +199 -0
- package/docs/providers/vydra.md +180 -0
- package/docs/providers/xai.md +571 -0
- package/docs/providers/xiaomi.md +286 -0
- package/docs/providers/zai.md +224 -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/database-first.md +2263 -0
- package/docs/refactor/ingress-core.md +341 -0
- package/docs/reference/AGENTS.default.md +131 -0
- package/docs/reference/RELEASING.md +844 -0
- package/docs/reference/api-usage-costs.md +208 -0
- package/docs/reference/application-modernization-plan.md +208 -0
- package/docs/reference/code-mode.md +1058 -0
- package/docs/reference/credits.md +33 -0
- package/docs/reference/device-models.md +50 -0
- package/docs/reference/full-release-validation.md +206 -0
- package/docs/reference/memory-config.md +630 -0
- package/docs/reference/prompt-caching.md +358 -0
- package/docs/reference/release-performance-sweep.md +347 -0
- package/docs/reference/rich-output-protocol.md +93 -0
- package/docs/reference/rpc.md +43 -0
- package/docs/reference/secret-placeholder-conventions.md +33 -0
- package/docs/reference/secretref-credential-surface.md +163 -0
- package/docs/reference/secretref-user-supplied-credentials-matrix.json +691 -0
- package/docs/reference/session-management-compaction.md +474 -0
- package/docs/reference/templates/AGENTS.dev.md +90 -0
- package/docs/reference/templates/AGENTS.md +227 -0
- package/docs/reference/templates/BOOT.md +16 -0
- package/docs/reference/templates/BOOTSTRAP.md +66 -0
- package/docs/reference/templates/HEARTBEAT.md +24 -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 +248 -0
- package/docs/reference/token-use.md +246 -0
- package/docs/reference/transcript-hygiene.md +226 -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/specs/claw-supervisor.md +247 -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 +98 -0
- package/docs/start/openclaw.md +246 -0
- package/docs/start/quickstart.md +25 -0
- package/docs/start/setup.md +178 -0
- package/docs/start/showcase.md +371 -0
- package/docs/start/wizard-cli-automation.md +232 -0
- package/docs/start/wizard-cli-reference.md +331 -0
- package/docs/start/wizard.md +142 -0
- package/docs/style.css +137 -0
- package/docs/tools/acp-agents-setup.md +356 -0
- package/docs/tools/acp-agents.md +865 -0
- package/docs/tools/agent-send.md +130 -0
- package/docs/tools/apply-patch.md +64 -0
- package/docs/tools/brave-search.md +139 -0
- package/docs/tools/browser-control.md +405 -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 +866 -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 +271 -0
- package/docs/tools/diffs.md +527 -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 +457 -0
- package/docs/tools/exec-approvals.md +520 -0
- package/docs/tools/exec.md +294 -0
- package/docs/tools/firecrawl.md +155 -0
- package/docs/tools/gemini-search.md +114 -0
- package/docs/tools/goal.md +217 -0
- package/docs/tools/grok-search.md +129 -0
- package/docs/tools/image-generation.md +538 -0
- package/docs/tools/index.md +176 -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 +161 -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 +372 -0
- package/docs/tools/ollama-search.md +153 -0
- package/docs/tools/parallel-search.md +154 -0
- package/docs/tools/pdf.md +213 -0
- package/docs/tools/permission-modes.md +111 -0
- package/docs/tools/perplexity-search.md +220 -0
- package/docs/tools/plugin.md +378 -0
- package/docs/tools/reactions.md +100 -0
- package/docs/tools/searxng-search.md +141 -0
- package/docs/tools/skill-workshop.md +283 -0
- package/docs/tools/skills-config.md +457 -0
- package/docs/tools/skills.md +591 -0
- package/docs/tools/slash-commands.md +518 -0
- package/docs/tools/steer.md +77 -0
- package/docs/tools/subagents.md +652 -0
- package/docs/tools/tavily.md +162 -0
- package/docs/tools/thinking.md +142 -0
- package/docs/tools/tokenjuice.md +84 -0
- package/docs/tools/tool-search.md +269 -0
- package/docs/tools/trajectory.md +229 -0
- package/docs/tools/tts.md +1013 -0
- package/docs/tools/video-generation.md +555 -0
- package/docs/tools/web-fetch.md +210 -0
- package/docs/tools/web.md +476 -0
- package/docs/tts.md +11 -0
- package/docs/vps.md +139 -0
- package/docs/web/control-ui.md +530 -0
- package/docs/web/dashboard.md +107 -0
- package/docs/web/index.md +133 -0
- package/docs/web/tui.md +258 -0
- package/docs/web/webchat.md +102 -0
- package/npm-shrinkwrap.json +3485 -0
- package/openclaw.mjs +661 -0
- package/package.json +1971 -0
- package/patches/.gitkeep +0 -0
- package/patches/@agentclientprotocol__claude-agent-acp@0.39.0.patch +40 -0
- package/pnpm-workspace.yaml +124 -0
- package/scripts/crabbox-wrapper.mjs +2470 -0
- package/scripts/lib/official-external-channel-catalog.json +570 -0
- package/scripts/lib/official-external-plugin-catalog.json +284 -0
- package/scripts/lib/official-external-provider-catalog.json +158 -0
- package/scripts/lib/package-dist-imports.mjs +174 -0
- package/scripts/npm-runner.mjs +95 -0
- package/scripts/postinstall-bundled-plugins.mjs +978 -0
- package/scripts/preinstall-package-manager-warning.mjs +74 -0
- package/scripts/prepare-git-hooks.mjs +73 -0
- package/scripts/windows-cmd-helpers.mjs +29 -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 +143 -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 +71 -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 +143 -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 +198 -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 +144 -0
- package/skills/skill-creator/scripts/quick_validate.py +169 -0
- package/skills/skill-creator/scripts/test_package_skill.py +199 -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 +87 -0
- package/skills/xurl/SKILL.md +120 -0
- package/src/agents/templates/HEARTBEAT.md +5 -0
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `openclaw tasks` (background task ledger and Task Flow state)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to inspect, audit, or cancel background task records
|
|
5
|
+
- You are documenting Task Flow commands under `openclaw tasks flow`
|
|
6
|
+
title: "`openclaw tasks`"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Inspect durable background tasks and Task Flow state. With no subcommand,
|
|
10
|
+
`openclaw tasks` is equivalent to `openclaw tasks list`.
|
|
11
|
+
|
|
12
|
+
See [Background Tasks](/automation/tasks) for the lifecycle and delivery model.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
openclaw tasks
|
|
18
|
+
openclaw tasks list
|
|
19
|
+
openclaw tasks list --runtime acp
|
|
20
|
+
openclaw tasks list --status running
|
|
21
|
+
openclaw tasks show <lookup>
|
|
22
|
+
openclaw tasks notify <lookup> state_changes
|
|
23
|
+
openclaw tasks cancel <lookup>
|
|
24
|
+
openclaw tasks audit
|
|
25
|
+
openclaw tasks maintenance
|
|
26
|
+
openclaw tasks maintenance --apply
|
|
27
|
+
openclaw tasks flow list
|
|
28
|
+
openclaw tasks flow show <lookup>
|
|
29
|
+
openclaw tasks flow cancel <lookup>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Root Options
|
|
33
|
+
|
|
34
|
+
- `--json`: output JSON.
|
|
35
|
+
- `--runtime <name>`: filter by kind: `subagent`, `acp`, `cron`, or `cli`.
|
|
36
|
+
- `--status <name>`: filter by status: `queued`, `running`, `succeeded`, `failed`, `timed_out`, `cancelled`, or `lost`.
|
|
37
|
+
|
|
38
|
+
## Subcommands
|
|
39
|
+
|
|
40
|
+
### `list`
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
openclaw tasks list [--runtime <name>] [--status <name>] [--json]
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Lists tracked background tasks newest first.
|
|
47
|
+
|
|
48
|
+
### `show`
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
openclaw tasks show <lookup> [--json]
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Shows one task by task ID, run ID, or session key.
|
|
55
|
+
|
|
56
|
+
### `notify`
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
openclaw tasks notify <lookup> <done_only|state_changes|silent>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Changes the notification policy for a running task.
|
|
63
|
+
|
|
64
|
+
### `cancel`
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
openclaw tasks cancel <lookup>
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Cancels a running background task.
|
|
71
|
+
|
|
72
|
+
### `audit`
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
openclaw tasks audit [--severity <warn|error>] [--code <name>] [--limit <n>] [--json]
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Surfaces stale, lost, delivery-failed, or otherwise inconsistent task and Task Flow records. Lost tasks retained until `cleanupAfter` are warnings; expired or unstamped lost tasks are errors.
|
|
79
|
+
|
|
80
|
+
### `maintenance`
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
openclaw tasks maintenance [--apply] [--json]
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Previews or applies task and Task Flow reconciliation, cleanup stamping, pruning,
|
|
87
|
+
and stale cron run session registry cleanup.
|
|
88
|
+
For cron tasks, reconciliation uses persisted run logs/job state before marking an
|
|
89
|
+
old active task `lost`, so completed cron runs do not become false audit errors
|
|
90
|
+
just because the in-memory Gateway runtime state is gone. Offline CLI audit is
|
|
91
|
+
not authoritative for the Gateway's process-local cron active-job set. CLI tasks
|
|
92
|
+
with a run id/source id are marked `lost` when their live Gateway run context is
|
|
93
|
+
gone, even if an old child-session row remains.
|
|
94
|
+
When applied, maintenance also prunes `cron:<jobId>:run:<uuid>` session registry
|
|
95
|
+
rows older than 7 days while preserving currently running cron jobs and leaving
|
|
96
|
+
non-cron session rows untouched.
|
|
97
|
+
|
|
98
|
+
### `flow`
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
openclaw tasks flow list [--status <name>] [--json]
|
|
102
|
+
openclaw tasks flow show <lookup> [--json]
|
|
103
|
+
openclaw tasks flow cancel <lookup>
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Inspects or cancels durable Task Flow state under the task ledger.
|
|
107
|
+
|
|
108
|
+
## Related
|
|
109
|
+
|
|
110
|
+
- [CLI reference](/cli)
|
|
111
|
+
- [Background tasks](/automation/tasks)
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `openclaw transcripts` (list, show, and locate stored transcripts)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to read stored transcript summaries from the terminal
|
|
5
|
+
- You need the path to a transcripts markdown summary
|
|
6
|
+
- You are debugging the core transcripts storage layout
|
|
7
|
+
title: "Transcripts CLI"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# `openclaw transcripts`
|
|
11
|
+
|
|
12
|
+
Inspect transcripts written by OpenClaw's core `transcripts` tool. This CLI is
|
|
13
|
+
read-only; capture, import, and summarization are owned by the agent tool and
|
|
14
|
+
configured auto-start sources.
|
|
15
|
+
|
|
16
|
+
Use the CLI when you want to find yesterday's notes, open the Markdown file in
|
|
17
|
+
an editor, feed a transcript to another tool, or debug where a session landed on
|
|
18
|
+
disk. It does not start or stop capture.
|
|
19
|
+
|
|
20
|
+
Artifacts live under the OpenClaw state directory:
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
$OPENCLAW_STATE_DIR/transcripts/YYYY-MM-DD/<session>/
|
|
24
|
+
metadata.json
|
|
25
|
+
transcript.jsonl
|
|
26
|
+
summary.json
|
|
27
|
+
summary.md
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The default state directory is `~/.openclaw`; set `OPENCLAW_STATE_DIR` to use a
|
|
31
|
+
different one. The date directory comes from the session start time, and the
|
|
32
|
+
session directory is a safe filesystem segment derived from the session id.
|
|
33
|
+
|
|
34
|
+
## Commands
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
openclaw transcripts list
|
|
38
|
+
openclaw transcripts show <session>
|
|
39
|
+
openclaw transcripts show YYYY-MM-DD/<session>
|
|
40
|
+
openclaw transcripts path <session>
|
|
41
|
+
openclaw transcripts path YYYY-MM-DD/<session>
|
|
42
|
+
openclaw transcripts path <session> --dir
|
|
43
|
+
openclaw transcripts path <session> --metadata
|
|
44
|
+
openclaw transcripts path <session> --transcript
|
|
45
|
+
openclaw transcripts list --json
|
|
46
|
+
openclaw transcripts show <session> --json
|
|
47
|
+
openclaw transcripts path <session> --json
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
- `list`: list stored sessions, date-qualified selector, start time, title, and `summary.md` path.
|
|
51
|
+
- `show <session>`: print the stored `summary.md`.
|
|
52
|
+
- `path <session>`: print the `summary.md` path.
|
|
53
|
+
- `path <session> --dir`: print the session directory.
|
|
54
|
+
- `path <session> --metadata`: print `metadata.json`.
|
|
55
|
+
- `path <session> --transcript`: print `transcript.jsonl`.
|
|
56
|
+
- `--json`: print machine-readable output.
|
|
57
|
+
|
|
58
|
+
When a human session id repeats across days, use the date-qualified selector
|
|
59
|
+
from `list`, for example `openclaw transcripts show 2026-05-22/standup`.
|
|
60
|
+
Default session ids include a timestamp and random suffix; configure fixed
|
|
61
|
+
session ids only when they are unique within the day.
|
|
62
|
+
|
|
63
|
+
## Output
|
|
64
|
+
|
|
65
|
+
`list` prints one session per line:
|
|
66
|
+
|
|
67
|
+
```text
|
|
68
|
+
2026-05-22/standup 2026-05-22T09:00:00.000Z Weekly standup /Users/alex/.openclaw/transcripts/2026-05-22/standup/summary.md
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
The output is tab-separated. The columns are selector, start time, title, and
|
|
72
|
+
summary path. The selector is the safest value to pass back to `show` or `path`.
|
|
73
|
+
|
|
74
|
+
`list --json` prints objects with:
|
|
75
|
+
|
|
76
|
+
- `sessionId`
|
|
77
|
+
- `selector`
|
|
78
|
+
- `date`
|
|
79
|
+
- `title`
|
|
80
|
+
- `startedAt`
|
|
81
|
+
- `stoppedAt`
|
|
82
|
+
- `source`
|
|
83
|
+
- `path`
|
|
84
|
+
- `summaryPath`
|
|
85
|
+
- `hasSummary`
|
|
86
|
+
|
|
87
|
+
`show --json` returns the stored session metadata, selector, session directory,
|
|
88
|
+
summary path, and summary Markdown text. `path --json` returns the selected path
|
|
89
|
+
and whether that file exists.
|
|
90
|
+
|
|
91
|
+
## Many meetings per day
|
|
92
|
+
|
|
93
|
+
Transcripts groups sessions by date, then by session id. Ten meetings on one
|
|
94
|
+
day become ten sibling folders:
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
~/.openclaw/transcripts/2026-05-22/
|
|
98
|
+
transcript-2026-05-22T09-00-00-000Z-a1b2c3d4/
|
|
99
|
+
transcript-2026-05-22T10-30-00-000Z-b2c3d4e5/
|
|
100
|
+
standup/
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Use default generated ids for most automation. Use a fixed id such as `standup`
|
|
104
|
+
only when the same id will not be used twice on the same date.
|
|
105
|
+
|
|
106
|
+
## Missing summaries
|
|
107
|
+
|
|
108
|
+
Live sessions write `summary.md` when the session stops. Imported transcripts
|
|
109
|
+
write `summary.md` immediately after import. A session can still appear in
|
|
110
|
+
`list` without a summary when capture is active, a provider failed during stop,
|
|
111
|
+
or metadata was written before any utterances arrived.
|
|
112
|
+
|
|
113
|
+
Use `path <session> --transcript` to inspect the append-only transcript, and use
|
|
114
|
+
the `transcripts` tool action `summarize` to regenerate the Markdown summary.
|
|
115
|
+
|
|
116
|
+
## Configuration
|
|
117
|
+
|
|
118
|
+
Transcript capture is opt-in because live sources can join and record meeting
|
|
119
|
+
audio. Enable the tool with top-level `transcripts.enabled`:
|
|
120
|
+
|
|
121
|
+
```json
|
|
122
|
+
{
|
|
123
|
+
"transcripts": {
|
|
124
|
+
"enabled": true,
|
|
125
|
+
"maxUtterances": 2000
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Configure auto-start sources with `transcripts.autoStart` in `openclaw.json`.
|
|
131
|
+
Each entry is enabled by being present; omit an entry to disable that source.
|
|
132
|
+
|
|
133
|
+
```json
|
|
134
|
+
{
|
|
135
|
+
"transcripts": {
|
|
136
|
+
"enabled": true,
|
|
137
|
+
"autoStart": [
|
|
138
|
+
{
|
|
139
|
+
"providerId": "discord-voice",
|
|
140
|
+
"guildId": "1234567890",
|
|
141
|
+
"channelId": "2345678901"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"providerId": "slack-huddle",
|
|
145
|
+
"accountId": "workspace",
|
|
146
|
+
"channelId": "C123"
|
|
147
|
+
}
|
|
148
|
+
]
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
```
|
package/docs/cli/tui.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `openclaw tui` (Gateway-backed or local embedded terminal UI)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want a terminal UI for the Gateway (remote-friendly)
|
|
5
|
+
- You want to pass url/token/session from scripts
|
|
6
|
+
- You want to run the TUI in local embedded mode without a Gateway
|
|
7
|
+
- You want to use openclaw chat or openclaw tui --local
|
|
8
|
+
title: "TUI"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# `openclaw tui`
|
|
12
|
+
|
|
13
|
+
Open the terminal UI connected to the Gateway, or run it in local embedded
|
|
14
|
+
mode.
|
|
15
|
+
|
|
16
|
+
Related:
|
|
17
|
+
|
|
18
|
+
- TUI guide: [TUI](/web/tui)
|
|
19
|
+
|
|
20
|
+
## Options
|
|
21
|
+
|
|
22
|
+
| Flag | Default | Description |
|
|
23
|
+
| --------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
24
|
+
| `--local` | `false` | Run against the local embedded agent runtime instead of a Gateway. |
|
|
25
|
+
| `--url <url>` | `gateway.remote.url` from config | Gateway WebSocket URL. |
|
|
26
|
+
| `--token <token>` | (none) | Gateway token if required. |
|
|
27
|
+
| `--password <pass>` | (none) | Gateway password if required. |
|
|
28
|
+
| `--session <key>` | `main` (or `global` when scope is global) | Session key. Inside an agent workspace it auto-selects that agent unless prefixed. |
|
|
29
|
+
| `--deliver` | `false` | Deliver assistant replies through configured channels. |
|
|
30
|
+
| `--thinking <level>` | (model default) | Thinking level override. |
|
|
31
|
+
| `--message <text>` | (none) | Send an initial message after connecting. |
|
|
32
|
+
| `--timeout-ms <ms>` | `agents.defaults.timeoutSeconds` | Agent timeout. Invalid values log a warning and are ignored. |
|
|
33
|
+
| `--history-limit <n>` | `200` | History entries to load on attach. |
|
|
34
|
+
|
|
35
|
+
Aliases: `openclaw chat` and `openclaw terminal` invoke the same command with `--local` implied.
|
|
36
|
+
|
|
37
|
+
Notes:
|
|
38
|
+
|
|
39
|
+
- `chat` and `terminal` are aliases for `openclaw tui --local`.
|
|
40
|
+
- `--local` cannot be combined with `--url`, `--token`, or `--password`.
|
|
41
|
+
- `tui` resolves configured gateway auth SecretRefs for token/password auth when possible (`env`/`file`/`exec` providers).
|
|
42
|
+
- When launched from inside a configured agent workspace directory, TUI auto-selects that agent for the session key default (unless `--session` is explicitly `agent:<id>:...`).
|
|
43
|
+
- To show the Gateway hostname in the footer for non-local URL-backed connections, run `openclaw config set tui.footer.showRemoteHost true`. The host label is off by default and never appears for loopback or embedded local connections.
|
|
44
|
+
- Local mode uses the embedded agent runtime directly. Most local tools work, but Gateway-only features are unavailable.
|
|
45
|
+
- Local mode adds `/auth [provider]` inside the TUI command surface.
|
|
46
|
+
- Plugin approval gates still apply in local mode. Tools that require approval prompt for a decision in the terminal; nothing is silently auto-approved because the Gateway is not involved.
|
|
47
|
+
- Session [goals](/tools/goal) appear in the footer and can be managed with `/goal`.
|
|
48
|
+
|
|
49
|
+
## Examples
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
openclaw chat
|
|
53
|
+
openclaw tui --local
|
|
54
|
+
openclaw tui
|
|
55
|
+
openclaw tui --url ws://127.0.0.1:18789 --token <token>
|
|
56
|
+
openclaw tui --session main --deliver
|
|
57
|
+
openclaw chat --message "Compare my config to the docs and tell me what to fix"
|
|
58
|
+
# when run inside an agent workspace, infers that agent automatically
|
|
59
|
+
openclaw tui --session bugfix
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Config repair loop
|
|
63
|
+
|
|
64
|
+
Use local mode when the current config already validates and you want the
|
|
65
|
+
embedded agent to inspect it, compare it against the docs, and help repair it
|
|
66
|
+
from the same terminal:
|
|
67
|
+
|
|
68
|
+
If `openclaw config validate` is already failing, use `openclaw configure` or
|
|
69
|
+
`openclaw doctor --fix` first. `openclaw chat` does not bypass the invalid-
|
|
70
|
+
config guard.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
openclaw chat
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Then inside the TUI:
|
|
77
|
+
|
|
78
|
+
```text
|
|
79
|
+
!openclaw config file
|
|
80
|
+
!openclaw docs gateway auth token secretref
|
|
81
|
+
!openclaw config validate
|
|
82
|
+
!openclaw doctor
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Apply targeted fixes with `openclaw config set` or `openclaw configure`, then
|
|
86
|
+
rerun `openclaw config validate`. See [TUI](/web/tui) and [Config](/cli/config).
|
|
87
|
+
|
|
88
|
+
## Related
|
|
89
|
+
|
|
90
|
+
- [CLI reference](/cli)
|
|
91
|
+
- [TUI](/web/tui)
|
|
92
|
+
- [Goal](/tools/goal)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `openclaw uninstall` (remove gateway service + local data)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to remove the gateway service and/or local state
|
|
5
|
+
- You want a dry-run first
|
|
6
|
+
title: "Uninstall"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `openclaw uninstall`
|
|
10
|
+
|
|
11
|
+
Uninstall the gateway service + local data (CLI remains).
|
|
12
|
+
|
|
13
|
+
Options:
|
|
14
|
+
|
|
15
|
+
- `--service`: remove the gateway service
|
|
16
|
+
- `--state`: remove state and config
|
|
17
|
+
- `--workspace`: remove workspace directories
|
|
18
|
+
- `--app`: remove the macOS app
|
|
19
|
+
- `--all`: remove service, state, workspace, and app
|
|
20
|
+
- `--yes`: skip confirmation prompts
|
|
21
|
+
- `--non-interactive`: disable prompts; requires `--yes`
|
|
22
|
+
- `--dry-run`: print actions without removing files
|
|
23
|
+
|
|
24
|
+
Examples:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
openclaw backup create
|
|
28
|
+
openclaw uninstall
|
|
29
|
+
openclaw uninstall --service --yes --non-interactive
|
|
30
|
+
openclaw uninstall --state --workspace --yes --non-interactive
|
|
31
|
+
openclaw uninstall --all --yes
|
|
32
|
+
openclaw uninstall --dry-run
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Notes:
|
|
36
|
+
|
|
37
|
+
- Run `openclaw backup create` first if you want a restorable snapshot before removing state or workspaces.
|
|
38
|
+
- `--state` preserves configured workspace directories unless `--workspace` is also selected.
|
|
39
|
+
- `--all` is shorthand for removing service, state, workspace, and app together.
|
|
40
|
+
- `--non-interactive` requires `--yes`.
|
|
41
|
+
|
|
42
|
+
## Related
|
|
43
|
+
|
|
44
|
+
- [CLI reference](/cli)
|
|
45
|
+
- [Uninstall](/install/uninstall)
|
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `openclaw update` (safe-ish source update + gateway auto-restart)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to update a source checkout safely
|
|
5
|
+
- You are debugging `openclaw update` output or options
|
|
6
|
+
- You need to understand `--update` shorthand behavior
|
|
7
|
+
title: "Update"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# `openclaw update`
|
|
11
|
+
|
|
12
|
+
Safely update OpenClaw and switch between stable/beta/dev channels.
|
|
13
|
+
|
|
14
|
+
If you installed via **npm/pnpm/bun** (global install, no git metadata),
|
|
15
|
+
updates happen via the package-manager flow in [Updating](/install/updating).
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
openclaw update
|
|
21
|
+
openclaw update status
|
|
22
|
+
openclaw update repair
|
|
23
|
+
openclaw update wizard
|
|
24
|
+
openclaw update --channel beta
|
|
25
|
+
openclaw update --channel dev
|
|
26
|
+
openclaw update --tag beta
|
|
27
|
+
openclaw update --tag main
|
|
28
|
+
openclaw update --dry-run
|
|
29
|
+
openclaw update --no-restart
|
|
30
|
+
openclaw update --yes
|
|
31
|
+
openclaw update --json
|
|
32
|
+
openclaw --update
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Options
|
|
36
|
+
|
|
37
|
+
- `--no-restart`: skip restarting the Gateway service after a successful update. Package-manager updates that do restart the Gateway verify the restarted service reports the expected updated version before the command succeeds.
|
|
38
|
+
- `--channel <stable|beta|dev>`: set the update channel (git + npm; persisted in config).
|
|
39
|
+
- `--tag <dist-tag|version|spec>`: override the package target for this update only. For package installs, `main` maps to `github:openclaw/openclaw#main`; GitHub/git source specs are packed into a temporary tarball before the staged global npm install.
|
|
40
|
+
- `--dry-run`: preview planned update actions (channel/tag/target/restart flow) without writing config, installing, syncing plugins, or restarting.
|
|
41
|
+
- `--json`: print machine-readable `UpdateRunResult` JSON, including
|
|
42
|
+
`postUpdate.plugins.warnings` when corrupt or unloadable managed plugins need
|
|
43
|
+
repair after the core update succeeds, beta-channel plugin fallback details
|
|
44
|
+
when a plugin has no beta release, and `postUpdate.plugins.integrityDrifts`
|
|
45
|
+
when npm plugin artifact drift is detected during post-update plugin sync.
|
|
46
|
+
- `--timeout <seconds>`: per-step timeout (default is 1800s).
|
|
47
|
+
- `--yes`: skip confirmation prompts (for example downgrade confirmation).
|
|
48
|
+
|
|
49
|
+
`openclaw update` does not have a `--verbose` flag. Use `--dry-run` to preview
|
|
50
|
+
the planned channel/tag/install/restart actions, `--json` for machine-readable
|
|
51
|
+
results, and `openclaw update status --json` when you only need channel and
|
|
52
|
+
availability details. If you are debugging Gateway logs around an update,
|
|
53
|
+
console verbosity and file log level are separate: Gateway `--verbose` affects
|
|
54
|
+
terminal/WebSocket output, while file logs require `logging.level: "debug"` or
|
|
55
|
+
`"trace"` in config. See [Gateway logging](/gateway/logging).
|
|
56
|
+
|
|
57
|
+
<Note>
|
|
58
|
+
In Nix mode (`OPENCLAW_NIX_MODE=1`), mutating `openclaw update` runs are disabled. Update the Nix source or flake input for this install instead; for nix-openclaw, use the agent-first [Quick Start](https://github.com/openclaw/nix-openclaw#quick-start). `openclaw update status` and `openclaw update --dry-run` remain read-only.
|
|
59
|
+
</Note>
|
|
60
|
+
|
|
61
|
+
<Warning>
|
|
62
|
+
Downgrades require confirmation because older versions can break configuration.
|
|
63
|
+
</Warning>
|
|
64
|
+
|
|
65
|
+
## `update status`
|
|
66
|
+
|
|
67
|
+
Show the active update channel + git tag/branch/SHA (for source checkouts), plus update availability.
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
openclaw update status
|
|
71
|
+
openclaw update status --json
|
|
72
|
+
openclaw update status --timeout 10
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Options:
|
|
76
|
+
|
|
77
|
+
- `--json`: print machine-readable status JSON.
|
|
78
|
+
- `--timeout <seconds>`: timeout for checks (default is 3s).
|
|
79
|
+
|
|
80
|
+
## `update repair`
|
|
81
|
+
|
|
82
|
+
Rerun update finalization after the core package already changed but later
|
|
83
|
+
repair work did not finish cleanly. This is the supported recovery path when
|
|
84
|
+
`openclaw update` installed the new core package but post-core plugin sync,
|
|
85
|
+
managed npm plugin metadata, registry refresh, or doctor repair still needs to
|
|
86
|
+
converge.
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
openclaw update repair
|
|
90
|
+
openclaw update repair --channel beta
|
|
91
|
+
openclaw update repair --json
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Options:
|
|
95
|
+
|
|
96
|
+
- `--channel <stable|beta|dev>`: persist the update channel before repair and
|
|
97
|
+
run plugin convergence against that channel.
|
|
98
|
+
- `--json`: print machine-readable finalization JSON.
|
|
99
|
+
- `--timeout <seconds>`: timeout for repair steps (default `1800`).
|
|
100
|
+
- `--yes`: skip confirmation prompts.
|
|
101
|
+
- `--no-restart`: accepted for update command parity; repair never restarts the
|
|
102
|
+
Gateway.
|
|
103
|
+
|
|
104
|
+
`openclaw update repair` runs `openclaw doctor --fix`, reloads the repaired
|
|
105
|
+
config and install records, syncs tracked plugins for the active update channel,
|
|
106
|
+
updates managed npm plugin installs, repairs missing configured plugin payloads,
|
|
107
|
+
refreshes the plugin registry, and writes the converged install-record metadata.
|
|
108
|
+
It does not install a new core package and does not restart the Gateway.
|
|
109
|
+
|
|
110
|
+
## `update wizard`
|
|
111
|
+
|
|
112
|
+
Interactive flow to pick an update channel and confirm whether to restart the Gateway
|
|
113
|
+
after updating (default is to restart). If you select `dev` without a git checkout, it
|
|
114
|
+
offers to create one.
|
|
115
|
+
|
|
116
|
+
Options:
|
|
117
|
+
|
|
118
|
+
- `--timeout <seconds>`: timeout for each update step (default `1800`)
|
|
119
|
+
|
|
120
|
+
## What it does
|
|
121
|
+
|
|
122
|
+
When you switch channels explicitly (`--channel ...`), OpenClaw also keeps the
|
|
123
|
+
install method aligned:
|
|
124
|
+
|
|
125
|
+
- `dev` → ensures a git checkout (default: `~/openclaw`, or `$OPENCLAW_HOME/openclaw` when
|
|
126
|
+
`OPENCLAW_HOME` is set; override with `OPENCLAW_GIT_DIR`),
|
|
127
|
+
updates it, and installs the global CLI from that checkout.
|
|
128
|
+
- `stable` → installs from npm using `latest`.
|
|
129
|
+
- `beta` → prefers npm dist-tag `beta`, but falls back to `latest` when beta is
|
|
130
|
+
missing or older than the current stable release.
|
|
131
|
+
|
|
132
|
+
The Gateway core auto-updater (when enabled via config) launches the CLI update path
|
|
133
|
+
outside the live Gateway request handler. Control-plane `update.run`
|
|
134
|
+
package-manager updates and supervised git-checkout updates also use a
|
|
135
|
+
managed-service handoff instead of replacing the package tree or rebuilding
|
|
136
|
+
`dist/` inside the live Gateway process. The Gateway starts a detached helper,
|
|
137
|
+
exits, and the helper runs the normal `openclaw update --yes --json` CLI path
|
|
138
|
+
from outside the Gateway process tree. If that handoff is unavailable,
|
|
139
|
+
`update.run` returns a structured response with the safe shell command to run
|
|
140
|
+
manually.
|
|
141
|
+
|
|
142
|
+
For package-manager installs, `openclaw update` resolves the target package
|
|
143
|
+
version before invoking the package manager. npm global installs use a staged
|
|
144
|
+
install: OpenClaw installs the new package into a temporary npm prefix, verifies
|
|
145
|
+
the packaged `dist` inventory there, then swaps that clean package tree into the
|
|
146
|
+
real global prefix. If verification fails, post-update doctor, plugin sync, and
|
|
147
|
+
restart work do not run from the suspect tree. Even when the installed version
|
|
148
|
+
already matches the target, the command refreshes the global package install,
|
|
149
|
+
then runs plugin sync, a core-command completion refresh, and restart work. This
|
|
150
|
+
keeps packaged sidecars and channel-owned plugin records aligned with the
|
|
151
|
+
installed OpenClaw build while leaving full plugin-command completion rebuilds to
|
|
152
|
+
explicit `openclaw completion --write-state` runs.
|
|
153
|
+
|
|
154
|
+
When a local managed Gateway service is installed and restart is enabled,
|
|
155
|
+
package-manager and git-checkout updates stop the running service before
|
|
156
|
+
replacing the package tree or mutating the checkout/build output. The updater
|
|
157
|
+
then refreshes the service metadata from the updated install, restarts the
|
|
158
|
+
service, and verifies the restarted Gateway before reporting
|
|
159
|
+
`Gateway: restarted and verified.`. Package-manager updates additionally verify
|
|
160
|
+
the restarted Gateway reports the expected package version; git-checkout updates
|
|
161
|
+
verify gateway health and service readiness after the rebuild. On macOS, the
|
|
162
|
+
post-update check also verifies the LaunchAgent is loaded/running for the active
|
|
163
|
+
profile and the configured loopback port is healthy. If the plist is installed
|
|
164
|
+
but launchd is not supervising it, OpenClaw re-bootstraps the LaunchAgent
|
|
165
|
+
automatically, then reruns the health/version/channel readiness checks. A fresh
|
|
166
|
+
bootstrap loads the RunAtLoad job directly, so update recovery does not
|
|
167
|
+
immediately `kickstart -k` the newly spawned Gateway. If the Gateway still does
|
|
168
|
+
not become healthy, the command exits non-zero and prints the restart log path
|
|
169
|
+
plus explicit restart, reinstall, and package rollback instructions. If restart
|
|
170
|
+
cannot run, the command prints `Gateway: restart skipped (...)` or
|
|
171
|
+
`Gateway: restart failed: ...` with a manual `openclaw gateway restart` hint.
|
|
172
|
+
With `--no-restart`, package replacement or git rebuild still runs but the
|
|
173
|
+
managed service is not stopped or restarted, so the running Gateway may keep old
|
|
174
|
+
code until you restart it manually.
|
|
175
|
+
|
|
176
|
+
### Control-plane response shape
|
|
177
|
+
|
|
178
|
+
When `update.run` is invoked through the Gateway control plane on a
|
|
179
|
+
package-manager install or supervised git checkout, the handler reports the
|
|
180
|
+
handoff initiation separately from the CLI update that continues after the
|
|
181
|
+
Gateway exits:
|
|
182
|
+
|
|
183
|
+
- `ok: true`, `result.status: "skipped"`,
|
|
184
|
+
`result.reason: "managed-service-handoff-started"`, and
|
|
185
|
+
`handoff.status: "started"` mean the Gateway created the managed-service
|
|
186
|
+
handoff and scheduled its own restart so the detached helper can run
|
|
187
|
+
`openclaw update --yes --json` outside the live service process.
|
|
188
|
+
- `ok: false`, `result.reason: "managed-service-handoff-unavailable"`, and
|
|
189
|
+
`handoff.status: "unavailable"` mean OpenClaw could not find a supervising
|
|
190
|
+
service boundary and durable service identity for a safe handoff. For
|
|
191
|
+
example, systemd handoff requires the OpenClaw unit identity
|
|
192
|
+
(`OPENCLAW_SYSTEMD_UNIT`), not only ambient systemd process markers. The
|
|
193
|
+
response includes `handoff.command`, the shell command to run from outside the
|
|
194
|
+
Gateway.
|
|
195
|
+
- `ok: false`, `result.reason: "managed-service-handoff-failed"` means the
|
|
196
|
+
Gateway tried to create the handoff but could not spawn the detached helper.
|
|
197
|
+
|
|
198
|
+
The `sentinel` payload is still written before the Gateway exits, and the CLI
|
|
199
|
+
handoff updates the same restart sentinel after the managed-service restart
|
|
200
|
+
health checks complete. During the handoff, the sentinel can carry
|
|
201
|
+
`stats.reason: "restart-health-pending"` with no success continuation; the
|
|
202
|
+
restarted Gateway keeps polling it and only fires the continuation after the CLI
|
|
203
|
+
has verified service health and rewritten the sentinel with the final `ok`
|
|
204
|
+
result. `openclaw status` and `openclaw status --all` show an `Update restart`
|
|
205
|
+
row while that sentinel is pending or failed, and `update.status` refreshes and
|
|
206
|
+
returns the latest sentinel.
|
|
207
|
+
|
|
208
|
+
## Git checkout flow
|
|
209
|
+
|
|
210
|
+
### Channel selection
|
|
211
|
+
|
|
212
|
+
- `stable`: checkout the latest non-beta tag, then build and doctor.
|
|
213
|
+
- `beta`: prefer the latest `-beta` tag, but fall back to the latest stable tag when beta is missing or older.
|
|
214
|
+
- `dev`: checkout `main`, then fetch and rebase.
|
|
215
|
+
|
|
216
|
+
### Update steps
|
|
217
|
+
|
|
218
|
+
<Steps>
|
|
219
|
+
<Step title="Verify clean worktree">
|
|
220
|
+
Requires no uncommitted changes.
|
|
221
|
+
</Step>
|
|
222
|
+
<Step title="Switch channel">
|
|
223
|
+
Switches to the selected channel (tag or branch).
|
|
224
|
+
</Step>
|
|
225
|
+
<Step title="Fetch upstream">
|
|
226
|
+
Dev only.
|
|
227
|
+
</Step>
|
|
228
|
+
<Step title="Preflight build (dev only)">
|
|
229
|
+
Runs the TypeScript build in a temp worktree. If the tip fails, walks back up to 10 commits to find the newest buildable commit. Set `OPENCLAW_UPDATE_PREFLIGHT_LINT=1` to also run lint during this preflight; lint runs in constrained serial mode because user update hosts are often smaller than CI runners.
|
|
230
|
+
</Step>
|
|
231
|
+
<Step title="Rebase">
|
|
232
|
+
Rebases onto the selected commit (dev only).
|
|
233
|
+
</Step>
|
|
234
|
+
<Step title="Install dependencies">
|
|
235
|
+
Uses the repo package manager. For pnpm checkouts, the updater bootstraps `pnpm` on demand (via `corepack` first, then a temporary `npm install pnpm@11` fallback) instead of running `npm run build` inside a pnpm workspace.
|
|
236
|
+
</Step>
|
|
237
|
+
<Step title="Build Control UI">
|
|
238
|
+
Builds the gateway and the Control UI.
|
|
239
|
+
</Step>
|
|
240
|
+
<Step title="Run doctor">
|
|
241
|
+
`openclaw doctor` runs as the final safe-update check.
|
|
242
|
+
</Step>
|
|
243
|
+
<Step title="Sync plugins">
|
|
244
|
+
Syncs plugins to the active channel. Dev uses bundled plugins; stable and beta use npm. Updates tracked plugin installs.
|
|
245
|
+
</Step>
|
|
246
|
+
</Steps>
|
|
247
|
+
|
|
248
|
+
On the beta update channel, tracked npm and ClawHub plugin installs that follow
|
|
249
|
+
the default/latest line try a plugin `@beta` release first. If the plugin has no
|
|
250
|
+
beta release, OpenClaw falls back to the recorded default/latest spec and reports
|
|
251
|
+
that as a warning. For npm plugins, OpenClaw also falls back when the beta
|
|
252
|
+
package exists but fails install validation. These plugin fallback warnings do
|
|
253
|
+
not make the core update fail. Exact versions and explicit tags are not
|
|
254
|
+
rewritten.
|
|
255
|
+
|
|
256
|
+
<Warning>
|
|
257
|
+
If an exact pinned npm plugin update resolves to an artifact whose integrity differs from the stored install record, `openclaw update` aborts that plugin artifact update instead of installing it. Reinstall or update the plugin explicitly only after verifying that you trust the new artifact.
|
|
258
|
+
</Warning>
|
|
259
|
+
|
|
260
|
+
<Note>
|
|
261
|
+
Post-update plugin sync failures that are scoped to a managed plugin and that the sync path can route around (e.g. an unreachable npm registry for a non-essential plugin) are reported as warnings after the core update succeeds. The JSON result keeps the top-level update `status: "ok"` and reports `postUpdate.plugins.status: "warning"` with `openclaw update repair` and `openclaw plugins inspect <id> --runtime --json` guidance. Unexpected updater or sync exceptions still fail the update result. Fix the plugin install or update error, then rerun `openclaw update repair`.
|
|
262
|
+
|
|
263
|
+
After the per-plugin sync step, `openclaw update` runs a mandatory **post-core convergence** pass before the gateway is restarted: it repairs missing configured plugin payloads, validates each _active_ tracked install record on disk, and statically verifies its `package.json` is parseable (and any explicitly-declared `main` exists). Failures from this pass — and an invalid OpenClaw config snapshot — return `postUpdate.plugins.status: "error"` and flip the top-level update `status` to `"error"`, so `openclaw update` exits non-zero and the gateway is _not_ restarted with an unverified plugin set. The error includes structured `postUpdate.plugins.warnings[].guidance` lines pointing at `openclaw update repair` and `openclaw plugins inspect <id> --runtime --json` for follow-up. Disabled plugin entries and records that are not trusted-source-linked official sync targets are skipped here, mirroring the `skipDisabledPlugins` policy used by the missing-payload check, so a stale disabled plugin record cannot block an otherwise valid update.
|
|
264
|
+
|
|
265
|
+
When the updated Gateway starts, plugin loading is verify-only: startup does not
|
|
266
|
+
run package managers or mutate dependency trees. Package-manager `update.run`
|
|
267
|
+
restarts are handed to the CLI managed-service path, so the package swap happens
|
|
268
|
+
outside the old Gateway process and the service health checks decide whether the
|
|
269
|
+
update can be reported as complete.
|
|
270
|
+
|
|
271
|
+
If pnpm bootstrap still fails, the updater stops early with a package-manager-specific error instead of trying `npm run build` inside the checkout.
|
|
272
|
+
</Note>
|
|
273
|
+
|
|
274
|
+
## `--update` shorthand
|
|
275
|
+
|
|
276
|
+
`openclaw --update` rewrites to `openclaw update` (useful for shells and launcher scripts).
|
|
277
|
+
|
|
278
|
+
## Related
|
|
279
|
+
|
|
280
|
+
- `openclaw doctor` (offers to run update first on git checkouts)
|
|
281
|
+
- [Development channels](/install/development-channels)
|
|
282
|
+
- [Updating](/install/updating)
|
|
283
|
+
- [CLI reference](/cli)
|