@quantumclaw/quantumclaw 2026.3.22
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 +4601 -0
- package/LICENSE +21 -0
- package/README.md +559 -0
- package/assets/avatar-placeholder.svg +19 -0
- package/assets/chrome-extension/icons/icon128.png +0 -0
- package/assets/chrome-extension/icons/icon16.png +0 -0
- package/assets/chrome-extension/icons/icon32.png +0 -0
- package/assets/chrome-extension/icons/icon48.png +0 -0
- package/assets/dmg-background-small.png +0 -0
- package/assets/dmg-background.png +0 -0
- package/docs/.i18n/README.md +31 -0
- package/docs/.i18n/glossary.ja-JP.json +14 -0
- package/docs/.i18n/glossary.zh-CN.json +302 -0
- package/docs/.i18n/ja-JP.tm.jsonl +0 -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/pixel-lobster.svg +60 -0
- package/docs/assets/quantumclaw-logo-text-dark.png +0 -0
- package/docs/assets/quantumclaw-logo-text-dark.svg +418 -0
- package/docs/assets/quantumclaw-logo-text.png +0 -0
- package/docs/assets/quantumclaw-logo-text.svg +418 -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.svg +14 -0
- package/docs/assets/sponsors/convex.svg +16 -0
- package/docs/assets/sponsors/openai.svg +3 -0
- package/docs/assets/sponsors/vercel.svg +5 -0
- package/docs/auth-credential-semantics.md +53 -0
- package/docs/automation/auth-monitoring.md +44 -0
- package/docs/automation/cron-jobs.md +727 -0
- package/docs/automation/cron-vs-heartbeat.md +286 -0
- package/docs/automation/gmail-pubsub.md +256 -0
- package/docs/automation/hooks.md +1056 -0
- package/docs/automation/poll.md +86 -0
- package/docs/automation/standing-orders.md +251 -0
- package/docs/automation/troubleshooting.md +122 -0
- package/docs/automation/webhook.md +217 -0
- package/docs/brave-search.md +93 -0
- package/docs/channels/bluebubbles.md +347 -0
- package/docs/channels/broadcast-groups.md +442 -0
- package/docs/channels/channel-routing.md +139 -0
- package/docs/channels/discord.md +1229 -0
- package/docs/channels/feishu.md +747 -0
- package/docs/channels/googlechat.md +261 -0
- package/docs/channels/group-messages.md +84 -0
- package/docs/channels/groups.md +379 -0
- package/docs/channels/imessage.md +367 -0
- package/docs/channels/index.md +47 -0
- package/docs/channels/irc.md +242 -0
- package/docs/channels/line.md +194 -0
- package/docs/channels/location.md +56 -0
- package/docs/channels/matrix.md +677 -0
- package/docs/channels/mattermost.md +427 -0
- package/docs/channels/msteams.md +780 -0
- package/docs/channels/nextcloud-talk.md +138 -0
- package/docs/channels/nostr.md +249 -0
- package/docs/channels/pairing.md +114 -0
- package/docs/channels/signal.md +329 -0
- package/docs/channels/slack.md +603 -0
- package/docs/channels/synology-chat.md +134 -0
- package/docs/channels/telegram.md +987 -0
- package/docs/channels/tlon.md +276 -0
- package/docs/channels/troubleshooting.md +118 -0
- package/docs/channels/twitch.md +379 -0
- package/docs/channels/whatsapp.md +460 -0
- package/docs/channels/zalo.md +243 -0
- package/docs/channels/zalouser.md +181 -0
- package/docs/ci.md +55 -0
- package/docs/cli/acp.md +288 -0
- package/docs/cli/agent.md +29 -0
- package/docs/cli/agents.md +123 -0
- package/docs/cli/approvals.md +50 -0
- package/docs/cli/backup.md +76 -0
- package/docs/cli/browser.md +106 -0
- package/docs/cli/channels.md +102 -0
- package/docs/cli/clawbot.md +21 -0
- package/docs/cli/completion.md +35 -0
- package/docs/cli/config.md +295 -0
- package/docs/cli/configure.md +36 -0
- package/docs/cli/cron.md +77 -0
- package/docs/cli/daemon.md +53 -0
- package/docs/cli/dashboard.md +22 -0
- package/docs/cli/devices.md +139 -0
- package/docs/cli/directory.md +63 -0
- package/docs/cli/dns.md +23 -0
- package/docs/cli/docs.md +15 -0
- package/docs/cli/doctor.md +48 -0
- package/docs/cli/gateway.md +235 -0
- package/docs/cli/health.md +21 -0
- package/docs/cli/hooks.md +329 -0
- package/docs/cli/index.md +1150 -0
- package/docs/cli/logs.md +28 -0
- package/docs/cli/memory.md +66 -0
- package/docs/cli/message.md +278 -0
- package/docs/cli/models.md +81 -0
- package/docs/cli/node.md +127 -0
- package/docs/cli/nodes.md +75 -0
- package/docs/cli/onboard.md +157 -0
- package/docs/cli/pairing.md +32 -0
- package/docs/cli/plugins.md +210 -0
- package/docs/cli/qr.md +46 -0
- package/docs/cli/reset.md +20 -0
- package/docs/cli/sandbox.md +197 -0
- package/docs/cli/secrets.md +188 -0
- package/docs/cli/security.md +79 -0
- package/docs/cli/sessions.md +110 -0
- package/docs/cli/setup.md +29 -0
- package/docs/cli/skills.md +36 -0
- package/docs/cli/status.md +30 -0
- package/docs/cli/system.md +60 -0
- package/docs/cli/tui.md +30 -0
- package/docs/cli/uninstall.md +20 -0
- package/docs/cli/update.md +103 -0
- package/docs/cli/voicecall.md +34 -0
- package/docs/cli/webhooks.md +25 -0
- package/docs/concepts/agent-loop.md +148 -0
- package/docs/concepts/agent-workspace.md +236 -0
- package/docs/concepts/agent.md +122 -0
- package/docs/concepts/architecture.md +137 -0
- package/docs/concepts/compaction.md +123 -0
- package/docs/concepts/context-engine.md +268 -0
- package/docs/concepts/context.md +172 -0
- package/docs/concepts/delegate-architecture.md +296 -0
- package/docs/concepts/features.md +73 -0
- package/docs/concepts/markdown-formatting.md +130 -0
- package/docs/concepts/memory.md +108 -0
- package/docs/concepts/messages.md +154 -0
- package/docs/concepts/model-failover.md +152 -0
- package/docs/concepts/model-providers.md +607 -0
- package/docs/concepts/models.md +225 -0
- package/docs/concepts/multi-agent.md +552 -0
- package/docs/concepts/oauth.md +158 -0
- package/docs/concepts/presence.md +102 -0
- package/docs/concepts/queue.md +89 -0
- package/docs/concepts/retry.md +69 -0
- package/docs/concepts/session-pruning.md +121 -0
- package/docs/concepts/session-tool.md +242 -0
- package/docs/concepts/session.md +310 -0
- package/docs/concepts/streaming.md +155 -0
- package/docs/concepts/system-prompt.md +132 -0
- package/docs/concepts/timezone.md +91 -0
- package/docs/concepts/typebox.md +291 -0
- package/docs/concepts/typing-indicators.md +68 -0
- package/docs/concepts/usage-tracking.md +35 -0
- package/docs/date-time.md +128 -0
- package/docs/debug/node-issue.md +85 -0
- package/docs/diagnostics/flags.md +91 -0
- package/docs/docs.json +2078 -0
- package/docs/gateway/authentication.md +179 -0
- package/docs/gateway/background-process.md +97 -0
- package/docs/gateway/bonjour.md +177 -0
- package/docs/gateway/bridge-protocol.md +91 -0
- package/docs/gateway/cli-backends.md +225 -0
- package/docs/gateway/configuration-examples.md +651 -0
- package/docs/gateway/configuration-reference.md +3123 -0
- package/docs/gateway/configuration.md +633 -0
- package/docs/gateway/discovery.md +123 -0
- package/docs/gateway/doctor.md +362 -0
- package/docs/gateway/gateway-lock.md +34 -0
- package/docs/gateway/health.md +44 -0
- package/docs/gateway/heartbeat.md +393 -0
- package/docs/gateway/index.md +261 -0
- package/docs/gateway/local-models.md +152 -0
- package/docs/gateway/logging.md +113 -0
- package/docs/gateway/multiple-gateways.md +112 -0
- package/docs/gateway/network-model.md +22 -0
- package/docs/gateway/openai-http-api.md +132 -0
- package/docs/gateway/openresponses-http-api.md +295 -0
- package/docs/gateway/openshell.md +307 -0
- package/docs/gateway/pairing.md +99 -0
- package/docs/gateway/protocol.md +267 -0
- package/docs/gateway/remote-gateway-readme.md +158 -0
- package/docs/gateway/remote.md +153 -0
- package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +134 -0
- package/docs/gateway/sandboxing.md +469 -0
- package/docs/gateway/secrets-plan-contract.md +116 -0
- package/docs/gateway/secrets.md +503 -0
- package/docs/gateway/security/index.md +1220 -0
- package/docs/gateway/tailscale.md +132 -0
- package/docs/gateway/tools-invoke-http-api.md +118 -0
- package/docs/gateway/troubleshooting.md +378 -0
- package/docs/gateway/trusted-proxy-auth.md +330 -0
- package/docs/help/debugging.md +168 -0
- package/docs/help/environment.md +163 -0
- package/docs/help/faq.md +2997 -0
- package/docs/help/index.md +28 -0
- package/docs/help/scripts.md +28 -0
- package/docs/help/testing.md +526 -0
- package/docs/help/troubleshooting.md +297 -0
- package/docs/images/configure-model-picker-unsearchable.png +0 -0
- package/docs/images/feishu-step2-create-app.png +0 -0
- package/docs/images/feishu-step3-credentials.png +0 -0
- package/docs/images/feishu-step4-permissions.png +0 -0
- package/docs/images/feishu-step5-bot-capability.png +0 -0
- package/docs/images/feishu-step6-event-subscription.png +0 -0
- package/docs/images/feishu-verification-token.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 +230 -0
- package/docs/install/azure.md +311 -0
- package/docs/install/bun.md +55 -0
- package/docs/install/development-channels.md +120 -0
- package/docs/install/digitalocean.md +129 -0
- package/docs/install/docker-vm-runtime.md +142 -0
- package/docs/install/docker.md +375 -0
- package/docs/install/exe-dev.md +126 -0
- package/docs/install/fly.md +501 -0
- package/docs/install/gcp.md +402 -0
- package/docs/install/hetzner.md +251 -0
- package/docs/install/index.md +183 -0
- package/docs/install/installer.md +415 -0
- package/docs/install/kubernetes.md +191 -0
- package/docs/install/macos-vm.md +281 -0
- package/docs/install/migrating-matrix.md +346 -0
- package/docs/install/migrating.md +110 -0
- package/docs/install/nix.md +89 -0
- package/docs/install/node.md +138 -0
- package/docs/install/northflank.mdx +54 -0
- package/docs/install/oracle.md +156 -0
- package/docs/install/podman.md +133 -0
- package/docs/install/railway.mdx +100 -0
- package/docs/install/raspberry-pi.md +159 -0
- package/docs/install/render.mdx +169 -0
- package/docs/install/uninstall.md +128 -0
- package/docs/install/updating.md +128 -0
- package/docs/ja-JP/index.md +186 -0
- package/docs/ja-JP/start/getting-started.md +125 -0
- package/docs/ja-JP/start/wizard.md +77 -0
- package/docs/logging.md +352 -0
- package/docs/nav-tabs-underline.js +100 -0
- package/docs/network.md +54 -0
- package/docs/nodes/audio.md +187 -0
- package/docs/nodes/camera.md +162 -0
- package/docs/nodes/images.md +72 -0
- package/docs/nodes/index.md +393 -0
- package/docs/nodes/location-command.md +98 -0
- package/docs/nodes/media-understanding.md +394 -0
- package/docs/nodes/talk.md +92 -0
- package/docs/nodes/troubleshooting.md +114 -0
- package/docs/nodes/voicewake.md +66 -0
- package/docs/perplexity.md +174 -0
- package/docs/pi-dev.md +80 -0
- package/docs/pi.md +567 -0
- package/docs/platforms/android.md +168 -0
- package/docs/platforms/digitalocean.md +266 -0
- package/docs/platforms/index.md +54 -0
- package/docs/platforms/ios.md +220 -0
- package/docs/platforms/linux.md +94 -0
- package/docs/platforms/mac/bundled-gateway.md +73 -0
- package/docs/platforms/mac/canvas.md +125 -0
- package/docs/platforms/mac/child-process.md +69 -0
- package/docs/platforms/mac/dev-setup.md +104 -0
- package/docs/platforms/mac/health.md +34 -0
- package/docs/platforms/mac/icon.md +31 -0
- package/docs/platforms/mac/logging.md +57 -0
- package/docs/platforms/mac/menu-bar.md +81 -0
- package/docs/platforms/mac/peekaboo.md +65 -0
- package/docs/platforms/mac/permissions.md +50 -0
- package/docs/platforms/mac/remote.md +84 -0
- package/docs/platforms/mac/signing.md +47 -0
- package/docs/platforms/mac/skills.md +33 -0
- package/docs/platforms/mac/voice-overlay.md +60 -0
- package/docs/platforms/mac/voicewake.md +67 -0
- package/docs/platforms/mac/webchat.md +43 -0
- package/docs/platforms/mac/xpc.md +61 -0
- package/docs/platforms/macos.md +226 -0
- package/docs/platforms/oracle.md +303 -0
- package/docs/platforms/raspberry-pi.md +412 -0
- package/docs/platforms/windows.md +241 -0
- package/docs/plugins/agent-tools.md +10 -0
- package/docs/plugins/architecture.md +1366 -0
- package/docs/plugins/building-extensions.md +10 -0
- package/docs/plugins/building-plugins.md +239 -0
- package/docs/plugins/bundles.md +181 -0
- package/docs/plugins/community.md +145 -0
- package/docs/plugins/manifest.md +241 -0
- package/docs/plugins/sdk-channel-plugins.md +370 -0
- package/docs/plugins/sdk-entrypoints.md +161 -0
- package/docs/plugins/sdk-migration.md +172 -0
- package/docs/plugins/sdk-overview.md +196 -0
- package/docs/plugins/sdk-provider-plugins.md +370 -0
- package/docs/plugins/sdk-runtime.md +345 -0
- package/docs/plugins/sdk-setup.md +331 -0
- package/docs/plugins/sdk-testing.md +263 -0
- package/docs/plugins/voice-call.md +380 -0
- package/docs/plugins/zalouser.md +77 -0
- package/docs/prose.md +134 -0
- package/docs/providers/anthropic.md +259 -0
- package/docs/providers/bedrock.md +176 -0
- package/docs/providers/claude-max-api-proxy.md +154 -0
- package/docs/providers/cloudflare-ai-gateway.md +71 -0
- package/docs/providers/deepgram.md +93 -0
- package/docs/providers/github-copilot.md +72 -0
- package/docs/providers/glm.md +43 -0
- package/docs/providers/google.md +78 -0
- package/docs/providers/groq.md +96 -0
- package/docs/providers/huggingface.md +209 -0
- package/docs/providers/index.md +69 -0
- package/docs/providers/kilocode.md +74 -0
- package/docs/providers/litellm.md +154 -0
- package/docs/providers/minimax.md +224 -0
- package/docs/providers/mistral.md +54 -0
- package/docs/providers/models.md +45 -0
- package/docs/providers/modelstudio.md +66 -0
- package/docs/providers/moonshot.md +175 -0
- package/docs/providers/nvidia.md +55 -0
- package/docs/providers/ollama.md +352 -0
- package/docs/providers/openai.md +303 -0
- package/docs/providers/opencode-go.md +45 -0
- package/docs/providers/opencode.md +64 -0
- package/docs/providers/openrouter.md +37 -0
- package/docs/providers/perplexity-provider.md +62 -0
- package/docs/providers/qianfan.md +38 -0
- package/docs/providers/qwen.md +53 -0
- package/docs/providers/sglang.md +104 -0
- package/docs/providers/synthetic.md +99 -0
- package/docs/providers/together.md +66 -0
- package/docs/providers/venice.md +282 -0
- package/docs/providers/vercel-ai-gateway.md +60 -0
- package/docs/providers/vllm.md +92 -0
- package/docs/providers/volcengine.md +74 -0
- package/docs/providers/xai.md +60 -0
- package/docs/providers/xiaomi.md +86 -0
- package/docs/providers/zai.md +46 -0
- package/docs/reference/AGENTS.default.md +126 -0
- package/docs/reference/RELEASING.md +42 -0
- package/docs/reference/api-usage-costs.md +144 -0
- package/docs/reference/credits.md +30 -0
- package/docs/reference/device-models.md +47 -0
- package/docs/reference/memory-config.md +711 -0
- package/docs/reference/prompt-caching.md +185 -0
- package/docs/reference/rpc.md +43 -0
- package/docs/reference/secretref-credential-surface.md +140 -0
- package/docs/reference/secretref-user-supplied-credentials-matrix.json +563 -0
- package/docs/reference/session-management-compaction.md +324 -0
- package/docs/reference/templates/AGENTS.dev.md +83 -0
- package/docs/reference/templates/AGENTS.md +219 -0
- package/docs/reference/templates/BOOT.md +11 -0
- package/docs/reference/templates/BOOTSTRAP.md +62 -0
- package/docs/reference/templates/HEARTBEAT.md +14 -0
- package/docs/reference/templates/IDENTITY.dev.md +47 -0
- package/docs/reference/templates/IDENTITY.md +29 -0
- package/docs/reference/templates/SOUL.dev.md +76 -0
- package/docs/reference/templates/SOUL.md +43 -0
- package/docs/reference/templates/TOOLS.dev.md +24 -0
- package/docs/reference/templates/TOOLS.md +47 -0
- package/docs/reference/templates/USER.dev.md +18 -0
- package/docs/reference/templates/USER.md +23 -0
- package/docs/reference/test.md +90 -0
- package/docs/reference/token-use.md +175 -0
- package/docs/reference/transcript-hygiene.md +151 -0
- package/docs/reference/wizard.md +235 -0
- package/docs/security/CONTRIBUTING-THREAT-MODEL.md +98 -0
- package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
- package/docs/security/formal-verification.md +167 -0
- package/docs/start/bootstrapping.md +41 -0
- package/docs/start/docs-directory.md +66 -0
- package/docs/start/getting-started.md +116 -0
- package/docs/start/hubs.md +198 -0
- package/docs/start/lore.md +219 -0
- package/docs/start/onboarding-overview.md +67 -0
- package/docs/start/onboarding.md +91 -0
- package/docs/start/openclaw.md +221 -0
- package/docs/start/quickstart.md +22 -0
- package/docs/start/setup.md +164 -0
- package/docs/start/showcase.md +418 -0
- package/docs/start/wizard-cli-automation.md +215 -0
- package/docs/start/wizard-cli-reference.md +299 -0
- package/docs/start/wizard.md +125 -0
- package/docs/style.css +37 -0
- package/docs/tools/acp-agents.md +623 -0
- package/docs/tools/agent-send.md +100 -0
- package/docs/tools/apply-patch.md +51 -0
- package/docs/tools/brave-search.md +93 -0
- package/docs/tools/browser-linux-troubleshooting.md +138 -0
- package/docs/tools/browser-login.md +73 -0
- package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +211 -0
- package/docs/tools/browser.md +731 -0
- package/docs/tools/btw.md +142 -0
- package/docs/tools/capability-cookbook.md +119 -0
- package/docs/tools/clawhub.md +298 -0
- package/docs/tools/creating-skills.md +117 -0
- package/docs/tools/diffs.md +386 -0
- package/docs/tools/elevated.md +114 -0
- package/docs/tools/exec-approvals.md +430 -0
- package/docs/tools/exec.md +207 -0
- package/docs/tools/firecrawl.md +140 -0
- package/docs/tools/index.md +137 -0
- package/docs/tools/llm-task.md +119 -0
- package/docs/tools/lobster.md +340 -0
- package/docs/tools/loop-detection.md +100 -0
- package/docs/tools/multi-agent-sandbox-tools.md +364 -0
- package/docs/tools/pdf.md +156 -0
- package/docs/tools/perplexity-search.md +174 -0
- package/docs/tools/plugin.md +255 -0
- package/docs/tools/reactions.md +64 -0
- package/docs/tools/skills-config.md +86 -0
- package/docs/tools/skills.md +309 -0
- package/docs/tools/slash-commands.md +294 -0
- package/docs/tools/subagents.md +295 -0
- package/docs/tools/tavily.md +125 -0
- package/docs/tools/thinking.md +96 -0
- package/docs/tools/tts.md +406 -0
- package/docs/tools/web.md +516 -0
- package/docs/tts.md +406 -0
- package/docs/vps.md +112 -0
- package/docs/web/control-ui.md +275 -0
- package/docs/web/dashboard.md +54 -0
- package/docs/web/index.md +120 -0
- package/docs/web/tui.md +170 -0
- package/docs/web/webchat.md +61 -0
- package/docs/whatsapp-openclaw-ai-zh.jpg +0 -0
- package/docs/whatsapp-openclaw.jpg +0 -0
- package/docs/zh-CN/AGENTS.md +61 -0
- package/docs/zh-CN/automation/auth-monitoring.md +47 -0
- package/docs/zh-CN/automation/cron-jobs.md +435 -0
- package/docs/zh-CN/automation/cron-vs-heartbeat.md +286 -0
- package/docs/zh-CN/automation/gmail-pubsub.md +249 -0
- package/docs/zh-CN/automation/hooks.md +1051 -0
- package/docs/zh-CN/automation/poll.md +76 -0
- package/docs/zh-CN/automation/troubleshooting.md +8 -0
- package/docs/zh-CN/automation/webhook.md +163 -0
- package/docs/zh-CN/brave-search.md +60 -0
- package/docs/zh-CN/channels/bluebubbles.md +354 -0
- package/docs/zh-CN/channels/broadcast-groups.md +449 -0
- package/docs/zh-CN/channels/channel-routing.md +117 -0
- package/docs/zh-CN/channels/discord.md +468 -0
- package/docs/zh-CN/channels/feishu.md +728 -0
- package/docs/zh-CN/channels/googlechat.md +257 -0
- package/docs/zh-CN/channels/grammy.md +38 -0
- package/docs/zh-CN/channels/group-messages.md +91 -0
- package/docs/zh-CN/channels/groups.md +379 -0
- package/docs/zh-CN/channels/imessage.md +302 -0
- package/docs/zh-CN/channels/index.md +53 -0
- package/docs/zh-CN/channels/line.md +180 -0
- package/docs/zh-CN/channels/location.md +63 -0
- package/docs/zh-CN/channels/matrix.md +221 -0
- package/docs/zh-CN/channels/mattermost.md +144 -0
- package/docs/zh-CN/channels/msteams.md +775 -0
- package/docs/zh-CN/channels/nextcloud-talk.md +142 -0
- package/docs/zh-CN/channels/nostr.md +249 -0
- package/docs/zh-CN/channels/pairing.md +89 -0
- package/docs/zh-CN/channels/signal.md +209 -0
- package/docs/zh-CN/channels/slack.md +531 -0
- package/docs/zh-CN/channels/synology-chat.md +138 -0
- package/docs/zh-CN/channels/telegram.md +751 -0
- package/docs/zh-CN/channels/tlon.md +136 -0
- package/docs/zh-CN/channels/troubleshooting.md +36 -0
- package/docs/zh-CN/channels/twitch.md +385 -0
- package/docs/zh-CN/channels/whatsapp.md +411 -0
- package/docs/zh-CN/channels/zalo.md +196 -0
- package/docs/zh-CN/channels/zalouser.md +147 -0
- package/docs/zh-CN/cli/acp.md +173 -0
- package/docs/zh-CN/cli/agent.md +30 -0
- package/docs/zh-CN/cli/agents.md +82 -0
- package/docs/zh-CN/cli/approvals.md +57 -0
- package/docs/zh-CN/cli/browser.md +114 -0
- package/docs/zh-CN/cli/channels.md +86 -0
- package/docs/zh-CN/cli/config.md +57 -0
- package/docs/zh-CN/cli/configure.md +38 -0
- package/docs/zh-CN/cli/cron.md +43 -0
- package/docs/zh-CN/cli/dashboard.md +23 -0
- package/docs/zh-CN/cli/devices.md +74 -0
- package/docs/zh-CN/cli/directory.md +70 -0
- package/docs/zh-CN/cli/dns.md +30 -0
- package/docs/zh-CN/cli/docs.md +22 -0
- package/docs/zh-CN/cli/doctor.md +48 -0
- package/docs/zh-CN/cli/gateway.md +206 -0
- package/docs/zh-CN/cli/health.md +28 -0
- package/docs/zh-CN/cli/hooks.md +298 -0
- package/docs/zh-CN/cli/index.md +1143 -0
- package/docs/zh-CN/cli/logs.md +31 -0
- package/docs/zh-CN/cli/memory.md +52 -0
- package/docs/zh-CN/cli/message.md +246 -0
- package/docs/zh-CN/cli/models.md +85 -0
- package/docs/zh-CN/cli/node.md +115 -0
- package/docs/zh-CN/cli/nodes.md +80 -0
- package/docs/zh-CN/cli/onboard.md +164 -0
- package/docs/zh-CN/cli/pairing.md +28 -0
- package/docs/zh-CN/cli/plugins.md +66 -0
- package/docs/zh-CN/cli/reset.md +24 -0
- package/docs/zh-CN/cli/sandbox.md +158 -0
- package/docs/zh-CN/cli/security.md +33 -0
- package/docs/zh-CN/cli/sessions.md +23 -0
- package/docs/zh-CN/cli/setup.md +36 -0
- package/docs/zh-CN/cli/skills.md +33 -0
- package/docs/zh-CN/cli/status.md +33 -0
- package/docs/zh-CN/cli/system.md +63 -0
- package/docs/zh-CN/cli/tui.md +30 -0
- package/docs/zh-CN/cli/uninstall.md +24 -0
- package/docs/zh-CN/cli/update.md +101 -0
- package/docs/zh-CN/cli/voicecall.md +41 -0
- package/docs/zh-CN/cli/webhooks.md +32 -0
- package/docs/zh-CN/concepts/agent-loop.md +146 -0
- package/docs/zh-CN/concepts/agent-workspace.md +219 -0
- package/docs/zh-CN/concepts/agent.md +115 -0
- package/docs/zh-CN/concepts/architecture.md +123 -0
- package/docs/zh-CN/concepts/compaction.md +67 -0
- package/docs/zh-CN/concepts/context.md +168 -0
- package/docs/zh-CN/concepts/features.md +59 -0
- package/docs/zh-CN/concepts/markdown-formatting.md +117 -0
- package/docs/zh-CN/concepts/memory.md +412 -0
- package/docs/zh-CN/concepts/messages.md +141 -0
- package/docs/zh-CN/concepts/model-failover.md +145 -0
- package/docs/zh-CN/concepts/model-providers.md +606 -0
- package/docs/zh-CN/concepts/models.md +225 -0
- package/docs/zh-CN/concepts/multi-agent.md +372 -0
- package/docs/zh-CN/concepts/oauth.md +164 -0
- package/docs/zh-CN/concepts/presence.md +99 -0
- package/docs/zh-CN/concepts/queue.md +94 -0
- package/docs/zh-CN/concepts/retry.md +76 -0
- package/docs/zh-CN/concepts/session-pruning.md +129 -0
- package/docs/zh-CN/concepts/session-tool.md +200 -0
- package/docs/zh-CN/concepts/session.md +166 -0
- package/docs/zh-CN/concepts/streaming.md +133 -0
- package/docs/zh-CN/concepts/system-prompt.md +101 -0
- package/docs/zh-CN/concepts/timezone.md +96 -0
- package/docs/zh-CN/concepts/typebox.md +284 -0
- package/docs/zh-CN/concepts/typing-indicators.md +74 -0
- package/docs/zh-CN/concepts/usage-tracking.md +42 -0
- package/docs/zh-CN/date-time.md +129 -0
- package/docs/zh-CN/debug/node-issue.md +90 -0
- package/docs/zh-CN/diagnostics/flags.md +98 -0
- package/docs/zh-CN/gateway/authentication.md +184 -0
- package/docs/zh-CN/gateway/background-process.md +100 -0
- package/docs/zh-CN/gateway/bonjour.md +174 -0
- package/docs/zh-CN/gateway/bridge-protocol.md +86 -0
- package/docs/zh-CN/gateway/cli-backends.md +213 -0
- package/docs/zh-CN/gateway/configuration-examples.md +587 -0
- package/docs/zh-CN/gateway/configuration-reference.md +3103 -0
- package/docs/zh-CN/gateway/configuration.md +640 -0
- package/docs/zh-CN/gateway/discovery.md +123 -0
- package/docs/zh-CN/gateway/doctor.md +238 -0
- package/docs/zh-CN/gateway/gateway-lock.md +41 -0
- package/docs/zh-CN/gateway/health.md +42 -0
- package/docs/zh-CN/gateway/heartbeat.md +274 -0
- package/docs/zh-CN/gateway/index.md +335 -0
- package/docs/zh-CN/gateway/local-models.md +159 -0
- package/docs/zh-CN/gateway/logging.md +114 -0
- package/docs/zh-CN/gateway/multiple-gateways.md +119 -0
- package/docs/zh-CN/gateway/network-model.md +23 -0
- package/docs/zh-CN/gateway/openai-http-api.md +125 -0
- package/docs/zh-CN/gateway/openresponses-http-api.md +317 -0
- package/docs/zh-CN/gateway/pairing.md +99 -0
- package/docs/zh-CN/gateway/protocol.md +220 -0
- package/docs/zh-CN/gateway/remote-gateway-readme.md +164 -0
- package/docs/zh-CN/gateway/remote.md +133 -0
- package/docs/zh-CN/gateway/sandbox-vs-tool-policy-vs-elevated.md +135 -0
- package/docs/zh-CN/gateway/sandboxing.md +188 -0
- package/docs/zh-CN/gateway/security/index.md +777 -0
- package/docs/zh-CN/gateway/tailscale.md +124 -0
- package/docs/zh-CN/gateway/tools-invoke-http-api.md +92 -0
- package/docs/zh-CN/gateway/troubleshooting.md +771 -0
- package/docs/zh-CN/help/debugging.md +160 -0
- package/docs/zh-CN/help/environment.md +88 -0
- package/docs/zh-CN/help/faq.md +2640 -0
- package/docs/zh-CN/help/index.md +28 -0
- package/docs/zh-CN/help/scripts.md +35 -0
- package/docs/zh-CN/help/testing.md +375 -0
- package/docs/zh-CN/help/troubleshooting.md +104 -0
- package/docs/zh-CN/index.md +186 -0
- package/docs/zh-CN/install/ansible.md +215 -0
- package/docs/zh-CN/install/bun.md +65 -0
- package/docs/zh-CN/install/development-channels.md +81 -0
- package/docs/zh-CN/install/docker.md +532 -0
- package/docs/zh-CN/install/exe-dev.md +133 -0
- package/docs/zh-CN/install/fly.md +490 -0
- package/docs/zh-CN/install/gcp.md +510 -0
- package/docs/zh-CN/install/hetzner.md +337 -0
- package/docs/zh-CN/install/index.md +235 -0
- package/docs/zh-CN/install/installer.md +422 -0
- package/docs/zh-CN/install/macos-vm.md +288 -0
- package/docs/zh-CN/install/migrating.md +199 -0
- package/docs/zh-CN/install/nix.md +99 -0
- package/docs/zh-CN/install/node.md +8 -0
- package/docs/zh-CN/install/northflank.mdx +60 -0
- package/docs/zh-CN/install/railway.mdx +106 -0
- package/docs/zh-CN/install/render.mdx +169 -0
- package/docs/zh-CN/install/uninstall.md +135 -0
- package/docs/zh-CN/install/updating.md +233 -0
- package/docs/zh-CN/logging.md +329 -0
- package/docs/zh-CN/network.md +59 -0
- package/docs/zh-CN/nodes/audio.md +120 -0
- package/docs/zh-CN/nodes/camera.md +162 -0
- package/docs/zh-CN/nodes/images.md +79 -0
- package/docs/zh-CN/nodes/index.md +348 -0
- package/docs/zh-CN/nodes/location-command.md +120 -0
- package/docs/zh-CN/nodes/media-understanding.md +380 -0
- package/docs/zh-CN/nodes/talk.md +97 -0
- package/docs/zh-CN/nodes/troubleshooting.md +8 -0
- package/docs/zh-CN/nodes/voicewake.md +72 -0
- package/docs/zh-CN/perplexity.md +102 -0
- package/docs/zh-CN/pi-dev.md +77 -0
- package/docs/zh-CN/pi.md +619 -0
- package/docs/zh-CN/platforms/android.md +155 -0
- package/docs/zh-CN/platforms/digitalocean.md +273 -0
- package/docs/zh-CN/platforms/index.md +60 -0
- package/docs/zh-CN/platforms/ios.md +114 -0
- package/docs/zh-CN/platforms/linux.md +100 -0
- package/docs/zh-CN/platforms/mac/bundled-gateway.md +75 -0
- package/docs/zh-CN/platforms/mac/canvas.md +128 -0
- package/docs/zh-CN/platforms/mac/child-process.md +73 -0
- package/docs/zh-CN/platforms/mac/dev-setup.md +109 -0
- package/docs/zh-CN/platforms/mac/health.md +41 -0
- package/docs/zh-CN/platforms/mac/icon.md +38 -0
- package/docs/zh-CN/platforms/mac/logging.md +64 -0
- package/docs/zh-CN/platforms/mac/menu-bar.md +88 -0
- package/docs/zh-CN/platforms/mac/peekaboo.md +62 -0
- package/docs/zh-CN/platforms/mac/permissions.md +46 -0
- package/docs/zh-CN/platforms/mac/remote.md +90 -0
- package/docs/zh-CN/platforms/mac/signing.md +54 -0
- package/docs/zh-CN/platforms/mac/skills.md +40 -0
- package/docs/zh-CN/platforms/mac/voice-overlay.md +67 -0
- package/docs/zh-CN/platforms/mac/voicewake.md +74 -0
- package/docs/zh-CN/platforms/mac/webchat.md +43 -0
- package/docs/zh-CN/platforms/mac/xpc.md +68 -0
- package/docs/zh-CN/platforms/macos.md +193 -0
- package/docs/zh-CN/platforms/oracle.md +310 -0
- package/docs/zh-CN/platforms/raspberry-pi.md +416 -0
- package/docs/zh-CN/platforms/windows.md +247 -0
- package/docs/zh-CN/plugins/agent-tools.md +99 -0
- package/docs/zh-CN/plugins/manifest.md +68 -0
- package/docs/zh-CN/plugins/voice-call.md +250 -0
- package/docs/zh-CN/plugins/zalouser.md +88 -0
- package/docs/zh-CN/prose.md +141 -0
- package/docs/zh-CN/providers/anthropic.md +265 -0
- package/docs/zh-CN/providers/bedrock.md +170 -0
- package/docs/zh-CN/providers/claude-max-api-proxy.md +155 -0
- package/docs/zh-CN/providers/cloudflare-ai-gateway.md +78 -0
- package/docs/zh-CN/providers/deepgram.md +97 -0
- package/docs/zh-CN/providers/github-copilot.md +67 -0
- package/docs/zh-CN/providers/glm.md +50 -0
- package/docs/zh-CN/providers/huggingface.md +216 -0
- package/docs/zh-CN/providers/index.md +69 -0
- package/docs/zh-CN/providers/kilocode.md +80 -0
- package/docs/zh-CN/providers/litellm.md +160 -0
- package/docs/zh-CN/providers/minimax.md +222 -0
- package/docs/zh-CN/providers/mistral.md +61 -0
- package/docs/zh-CN/providers/models.md +51 -0
- package/docs/zh-CN/providers/moonshot.md +182 -0
- package/docs/zh-CN/providers/nvidia.md +62 -0
- package/docs/zh-CN/providers/ollama.md +359 -0
- package/docs/zh-CN/providers/openai.md +308 -0
- package/docs/zh-CN/providers/opencode-go.md +52 -0
- package/docs/zh-CN/providers/opencode.md +71 -0
- package/docs/zh-CN/providers/openrouter.md +44 -0
- package/docs/zh-CN/providers/qianfan.md +45 -0
- package/docs/zh-CN/providers/qwen.md +55 -0
- package/docs/zh-CN/providers/sglang.md +111 -0
- package/docs/zh-CN/providers/synthetic.md +106 -0
- package/docs/zh-CN/providers/together.md +72 -0
- package/docs/zh-CN/providers/venice.md +289 -0
- package/docs/zh-CN/providers/vercel-ai-gateway.md +66 -0
- package/docs/zh-CN/providers/xiaomi.md +93 -0
- package/docs/zh-CN/providers/zai.md +53 -0
- package/docs/zh-CN/reference/AGENTS.default.md +131 -0
- package/docs/zh-CN/reference/RELEASING.md +48 -0
- package/docs/zh-CN/reference/api-usage-costs.md +141 -0
- package/docs/zh-CN/reference/credits.md +34 -0
- package/docs/zh-CN/reference/device-models.md +54 -0
- package/docs/zh-CN/reference/rpc.md +48 -0
- package/docs/zh-CN/reference/session-management-compaction.md +287 -0
- package/docs/zh-CN/reference/templates/AGENTS.dev.md +89 -0
- package/docs/zh-CN/reference/templates/AGENTS.md +225 -0
- package/docs/zh-CN/reference/templates/BOOT.md +17 -0
- package/docs/zh-CN/reference/templates/BOOTSTRAP.md +68 -0
- package/docs/zh-CN/reference/templates/HEARTBEAT.md +18 -0
- package/docs/zh-CN/reference/templates/IDENTITY.dev.md +54 -0
- package/docs/zh-CN/reference/templates/IDENTITY.md +36 -0
- package/docs/zh-CN/reference/templates/SOUL.dev.md +83 -0
- package/docs/zh-CN/reference/templates/SOUL.md +49 -0
- package/docs/zh-CN/reference/templates/TOOLS.dev.md +31 -0
- package/docs/zh-CN/reference/templates/TOOLS.md +53 -0
- package/docs/zh-CN/reference/templates/USER.dev.md +25 -0
- package/docs/zh-CN/reference/templates/USER.md +30 -0
- package/docs/zh-CN/reference/test.md +57 -0
- package/docs/zh-CN/reference/token-use.md +119 -0
- package/docs/zh-CN/reference/transcript-hygiene.md +109 -0
- package/docs/zh-CN/reference/wizard.md +242 -0
- package/docs/zh-CN/security/formal-verification.md +171 -0
- package/docs/zh-CN/start/bootstrapping.md +9 -0
- package/docs/zh-CN/start/docs-directory.md +70 -0
- package/docs/zh-CN/start/getting-started.md +143 -0
- package/docs/zh-CN/start/hubs.md +194 -0
- package/docs/zh-CN/start/lore.md +226 -0
- package/docs/zh-CN/start/onboarding-overview.md +58 -0
- package/docs/zh-CN/start/onboarding.md +105 -0
- package/docs/zh-CN/start/openclaw.md +248 -0
- package/docs/zh-CN/start/quickstart.md +88 -0
- package/docs/zh-CN/start/setup.md +153 -0
- package/docs/zh-CN/start/showcase.md +423 -0
- package/docs/zh-CN/start/wizard-cli-automation.md +222 -0
- package/docs/zh-CN/start/wizard-cli-reference.md +306 -0
- package/docs/zh-CN/start/wizard.md +132 -0
- package/docs/zh-CN/tools/agent-send.md +59 -0
- package/docs/zh-CN/tools/apply-patch.md +57 -0
- package/docs/zh-CN/tools/browser-linux-troubleshooting.md +144 -0
- package/docs/zh-CN/tools/browser-login.md +75 -0
- package/docs/zh-CN/tools/browser.md +553 -0
- package/docs/zh-CN/tools/chrome-extension.md +183 -0
- package/docs/zh-CN/tools/clawhub.md +209 -0
- package/docs/zh-CN/tools/creating-skills.md +61 -0
- package/docs/zh-CN/tools/elevated.md +64 -0
- package/docs/zh-CN/tools/exec-approvals.md +234 -0
- package/docs/zh-CN/tools/exec.md +169 -0
- package/docs/zh-CN/tools/firecrawl.md +68 -0
- package/docs/zh-CN/tools/index.md +515 -0
- package/docs/zh-CN/tools/llm-task.md +117 -0
- package/docs/zh-CN/tools/lobster.md +349 -0
- package/docs/zh-CN/tools/multi-agent-sandbox-tools.md +401 -0
- package/docs/zh-CN/tools/plugin.md +1612 -0
- package/docs/zh-CN/tools/reactions.md +29 -0
- package/docs/zh-CN/tools/skills-config.md +78 -0
- package/docs/zh-CN/tools/skills.md +279 -0
- package/docs/zh-CN/tools/slash-commands.md +205 -0
- package/docs/zh-CN/tools/subagents.md +167 -0
- package/docs/zh-CN/tools/thinking.md +80 -0
- package/docs/zh-CN/tools/web.md +289 -0
- package/docs/zh-CN/tts.md +375 -0
- package/docs/zh-CN/vps.md +47 -0
- package/docs/zh-CN/web/control-ui.md +191 -0
- package/docs/zh-CN/web/dashboard.md +53 -0
- package/docs/zh-CN/web/index.md +118 -0
- package/docs/zh-CN/web/tui.md +166 -0
- package/docs/zh-CN/web/webchat.md +56 -0
- package/package.json +841 -0
- package/quantumclaw.mjs +135 -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/bluebubbles/SKILL.md +131 -0
- package/skills/camsnap/SKILL.md +45 -0
- package/skills/canvas/SKILL.md +198 -0
- package/skills/clawhub/SKILL.md +77 -0
- package/skills/coding-agent/SKILL.md +295 -0
- package/skills/discord/SKILL.md +197 -0
- package/skills/eightctl/SKILL.md +50 -0
- package/skills/gemini/SKILL.md +43 -0
- package/skills/gh-issues/SKILL.md +865 -0
- package/skills/gifgrep/SKILL.md +79 -0
- package/skills/github/SKILL.md +163 -0
- package/skills/gog/SKILL.md +116 -0
- package/skills/goplaces/SKILL.md +52 -0
- package/skills/healthcheck/SKILL.md +245 -0
- package/skills/himalaya/SKILL.md +257 -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/model-usage/SKILL.md +69 -0
- package/skills/model-usage/references/codexbar-cli.md +33 -0
- package/skills/model-usage/scripts/model_usage.py +320 -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/notion/SKILL.md +174 -0
- package/skills/obsidian/SKILL.md +81 -0
- package/skills/openai-image-gen/SKILL.md +92 -0
- package/skills/openai-image-gen/scripts/gen.py +328 -0
- package/skills/openai-image-gen/scripts/test_gen.py +140 -0
- package/skills/openai-whisper/SKILL.md +38 -0
- package/skills/openai-whisper-api/SKILL.md +52 -0
- package/skills/openai-whisper-api/scripts/transcribe.sh +85 -0
- package/skills/openhue/SKILL.md +112 -0
- package/skills/oracle/SKILL.md +125 -0
- package/skills/ordercli/SKILL.md +78 -0
- package/skills/peekaboo/SKILL.md +190 -0
- package/skills/sag/SKILL.md +87 -0
- package/skills/session-logs/SKILL.md +115 -0
- package/skills/sherpa-onnx-tts/SKILL.md +103 -0
- package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
- package/skills/skill-creator/SKILL.md +372 -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 +159 -0
- package/skills/skill-creator/scripts/test_package_skill.py +160 -0
- package/skills/skill-creator/scripts/test_quick_validate.py +72 -0
- package/skills/slack/SKILL.md +144 -0
- package/skills/songsee/SKILL.md +49 -0
- package/skills/sonoscli/SKILL.md +65 -0
- package/skills/spotify-player/SKILL.md +64 -0
- package/skills/summarize/SKILL.md +87 -0
- package/skills/things-mac/SKILL.md +86 -0
- package/skills/tmux/SKILL.md +153 -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 +95 -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 +112 -0
- package/skills/xurl/SKILL.md +461 -0
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
import argparse
|
|
3
|
+
import base64
|
|
4
|
+
import datetime as dt
|
|
5
|
+
import json
|
|
6
|
+
import os
|
|
7
|
+
import random
|
|
8
|
+
import re
|
|
9
|
+
import sys
|
|
10
|
+
import urllib.error
|
|
11
|
+
import urllib.request
|
|
12
|
+
from collections.abc import Callable
|
|
13
|
+
from html import escape as html_escape
|
|
14
|
+
from pathlib import Path
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
def slugify(text: str) -> str:
|
|
18
|
+
text = text.lower().strip()
|
|
19
|
+
text = re.sub(r"[^a-z0-9]+", "-", text)
|
|
20
|
+
text = re.sub(r"-{2,}", "-", text).strip("-")
|
|
21
|
+
return text or "image"
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def default_out_dir() -> Path:
|
|
25
|
+
now = dt.datetime.now().strftime("%Y-%m-%d-%H-%M-%S")
|
|
26
|
+
preferred = Path.home() / "Projects" / "tmp"
|
|
27
|
+
base = preferred if preferred.is_dir() else Path("./tmp")
|
|
28
|
+
base.mkdir(parents=True, exist_ok=True)
|
|
29
|
+
return base / f"openai-image-gen-{now}"
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def pick_prompts(count: int) -> list[str]:
|
|
33
|
+
subjects = [
|
|
34
|
+
"a lobster astronaut",
|
|
35
|
+
"a brutalist lighthouse",
|
|
36
|
+
"a cozy reading nook",
|
|
37
|
+
"a cyberpunk noodle shop",
|
|
38
|
+
"a Vienna street at dusk",
|
|
39
|
+
"a minimalist product photo",
|
|
40
|
+
"a surreal underwater library",
|
|
41
|
+
]
|
|
42
|
+
styles = [
|
|
43
|
+
"ultra-detailed studio photo",
|
|
44
|
+
"35mm film still",
|
|
45
|
+
"isometric illustration",
|
|
46
|
+
"editorial photography",
|
|
47
|
+
"soft watercolor",
|
|
48
|
+
"architectural render",
|
|
49
|
+
"high-contrast monochrome",
|
|
50
|
+
]
|
|
51
|
+
lighting = [
|
|
52
|
+
"golden hour",
|
|
53
|
+
"overcast soft light",
|
|
54
|
+
"neon lighting",
|
|
55
|
+
"dramatic rim light",
|
|
56
|
+
"candlelight",
|
|
57
|
+
"foggy atmosphere",
|
|
58
|
+
]
|
|
59
|
+
prompts: list[str] = []
|
|
60
|
+
for _ in range(count):
|
|
61
|
+
prompts.append(
|
|
62
|
+
f"{random.choice(styles)} of {random.choice(subjects)}, {random.choice(lighting)}"
|
|
63
|
+
)
|
|
64
|
+
return prompts
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
def get_model_defaults(model: str) -> tuple[str, str]:
|
|
68
|
+
"""Return (default_size, default_quality) for the given model."""
|
|
69
|
+
if model == "dall-e-2":
|
|
70
|
+
# quality will be ignored
|
|
71
|
+
return ("1024x1024", "standard")
|
|
72
|
+
elif model == "dall-e-3":
|
|
73
|
+
return ("1024x1024", "standard")
|
|
74
|
+
else:
|
|
75
|
+
# GPT image or future models
|
|
76
|
+
return ("1024x1024", "high")
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
def normalize_optional_flag(
|
|
80
|
+
*,
|
|
81
|
+
model: str,
|
|
82
|
+
raw_value: str,
|
|
83
|
+
flag_name: str,
|
|
84
|
+
supported: Callable[[str], bool],
|
|
85
|
+
allowed: set[str],
|
|
86
|
+
allowed_text: str,
|
|
87
|
+
unsupported_message: str,
|
|
88
|
+
aliases: dict[str, str] | None = None,
|
|
89
|
+
) -> str:
|
|
90
|
+
"""Normalize a string flag, warn when unsupported, and reject invalid values."""
|
|
91
|
+
value = raw_value.strip().lower()
|
|
92
|
+
if not value:
|
|
93
|
+
return ""
|
|
94
|
+
|
|
95
|
+
if not supported(model):
|
|
96
|
+
print(unsupported_message.format(model=model), file=sys.stderr)
|
|
97
|
+
return ""
|
|
98
|
+
|
|
99
|
+
if aliases:
|
|
100
|
+
value = aliases.get(value, value)
|
|
101
|
+
|
|
102
|
+
if value not in allowed:
|
|
103
|
+
raise ValueError(
|
|
104
|
+
f"Invalid --{flag_name} '{raw_value}'. Allowed values: {allowed_text}."
|
|
105
|
+
)
|
|
106
|
+
return value
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
def normalize_background(model: str, background: str) -> str:
|
|
110
|
+
"""Validate --background for GPT image models."""
|
|
111
|
+
return normalize_optional_flag(
|
|
112
|
+
model=model,
|
|
113
|
+
raw_value=background,
|
|
114
|
+
flag_name="background",
|
|
115
|
+
supported=lambda candidate: candidate.startswith("gpt-image"),
|
|
116
|
+
allowed={"transparent", "opaque", "auto"},
|
|
117
|
+
allowed_text="transparent, opaque, auto",
|
|
118
|
+
unsupported_message=(
|
|
119
|
+
"Warning: --background is only supported for gpt-image models; "
|
|
120
|
+
"ignoring for '{model}'."
|
|
121
|
+
),
|
|
122
|
+
)
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
def normalize_style(model: str, style: str) -> str:
|
|
126
|
+
"""Validate --style for dall-e-3."""
|
|
127
|
+
return normalize_optional_flag(
|
|
128
|
+
model=model,
|
|
129
|
+
raw_value=style,
|
|
130
|
+
flag_name="style",
|
|
131
|
+
supported=lambda candidate: candidate == "dall-e-3",
|
|
132
|
+
allowed={"vivid", "natural"},
|
|
133
|
+
allowed_text="vivid, natural",
|
|
134
|
+
unsupported_message=(
|
|
135
|
+
"Warning: --style is only supported for dall-e-3; ignoring for '{model}'."
|
|
136
|
+
),
|
|
137
|
+
)
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
def normalize_output_format(model: str, output_format: str) -> str:
|
|
141
|
+
"""Normalize output format for GPT image models and validate allowed values."""
|
|
142
|
+
return normalize_optional_flag(
|
|
143
|
+
model=model,
|
|
144
|
+
raw_value=output_format,
|
|
145
|
+
flag_name="output-format",
|
|
146
|
+
supported=lambda candidate: candidate.startswith("gpt-image"),
|
|
147
|
+
allowed={"png", "jpeg", "webp"},
|
|
148
|
+
allowed_text="png, jpeg, webp",
|
|
149
|
+
unsupported_message=(
|
|
150
|
+
"Warning: --output-format is only supported for gpt-image models; "
|
|
151
|
+
"ignoring for '{model}'."
|
|
152
|
+
),
|
|
153
|
+
aliases={"jpg": "jpeg"},
|
|
154
|
+
)
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
def request_images(
|
|
158
|
+
api_key: str,
|
|
159
|
+
prompt: str,
|
|
160
|
+
model: str,
|
|
161
|
+
size: str,
|
|
162
|
+
quality: str,
|
|
163
|
+
background: str = "",
|
|
164
|
+
output_format: str = "",
|
|
165
|
+
style: str = "",
|
|
166
|
+
) -> dict:
|
|
167
|
+
url = "https://api.openai.com/v1/images/generations"
|
|
168
|
+
args = {
|
|
169
|
+
"model": model,
|
|
170
|
+
"prompt": prompt,
|
|
171
|
+
"size": size,
|
|
172
|
+
"n": 1,
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
# Quality parameter - dall-e-2 doesn't accept this parameter
|
|
176
|
+
if model != "dall-e-2":
|
|
177
|
+
args["quality"] = quality
|
|
178
|
+
|
|
179
|
+
# Note: response_format no longer supported by OpenAI Images API
|
|
180
|
+
# dall-e models now return URLs by default
|
|
181
|
+
|
|
182
|
+
if model.startswith("gpt-image"):
|
|
183
|
+
if background:
|
|
184
|
+
args["background"] = background
|
|
185
|
+
if output_format:
|
|
186
|
+
args["output_format"] = output_format
|
|
187
|
+
|
|
188
|
+
if model == "dall-e-3" and style:
|
|
189
|
+
args["style"] = style
|
|
190
|
+
|
|
191
|
+
body = json.dumps(args).encode("utf-8")
|
|
192
|
+
req = urllib.request.Request(
|
|
193
|
+
url,
|
|
194
|
+
method="POST",
|
|
195
|
+
headers={
|
|
196
|
+
"Authorization": f"Bearer {api_key}",
|
|
197
|
+
"Content-Type": "application/json",
|
|
198
|
+
},
|
|
199
|
+
data=body,
|
|
200
|
+
)
|
|
201
|
+
try:
|
|
202
|
+
with urllib.request.urlopen(req, timeout=300) as resp:
|
|
203
|
+
return json.loads(resp.read().decode("utf-8"))
|
|
204
|
+
except urllib.error.HTTPError as e:
|
|
205
|
+
payload = e.read().decode("utf-8", errors="replace")
|
|
206
|
+
raise RuntimeError(f"OpenAI Images API failed ({e.code}): {payload}") from e
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
def write_gallery(out_dir: Path, items: list[dict]) -> None:
|
|
210
|
+
thumbs = "\n".join(
|
|
211
|
+
[
|
|
212
|
+
f"""
|
|
213
|
+
<figure>
|
|
214
|
+
<a href="{html_escape(it["file"], quote=True)}"><img src="{html_escape(it["file"], quote=True)}" loading="lazy" /></a>
|
|
215
|
+
<figcaption>{html_escape(it["prompt"])}</figcaption>
|
|
216
|
+
</figure>
|
|
217
|
+
""".strip()
|
|
218
|
+
for it in items
|
|
219
|
+
]
|
|
220
|
+
)
|
|
221
|
+
html = f"""<!doctype html>
|
|
222
|
+
<meta charset="utf-8" />
|
|
223
|
+
<title>openai-image-gen</title>
|
|
224
|
+
<style>
|
|
225
|
+
:root {{ color-scheme: dark; }}
|
|
226
|
+
body {{ margin: 24px; font: 14px/1.4 ui-sans-serif, system-ui; background: #0b0f14; color: #e8edf2; }}
|
|
227
|
+
h1 {{ font-size: 18px; margin: 0 0 16px; }}
|
|
228
|
+
.grid {{ display: grid; grid-template-columns: repeat(auto-fill, minmax(240px, 1fr)); gap: 16px; }}
|
|
229
|
+
figure {{ margin: 0; padding: 12px; border: 1px solid #1e2a36; border-radius: 14px; background: #0f1620; }}
|
|
230
|
+
img {{ width: 100%; height: auto; border-radius: 10px; display: block; }}
|
|
231
|
+
figcaption {{ margin-top: 10px; color: #b7c2cc; }}
|
|
232
|
+
code {{ color: #9cd1ff; }}
|
|
233
|
+
</style>
|
|
234
|
+
<h1>openai-image-gen</h1>
|
|
235
|
+
<p>Output: <code>{html_escape(out_dir.as_posix())}</code></p>
|
|
236
|
+
<div class="grid">
|
|
237
|
+
{thumbs}
|
|
238
|
+
</div>
|
|
239
|
+
"""
|
|
240
|
+
(out_dir / "index.html").write_text(html, encoding="utf-8")
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
def main() -> int:
|
|
244
|
+
ap = argparse.ArgumentParser(description="Generate images via OpenAI Images API.")
|
|
245
|
+
ap.add_argument("--prompt", help="Single prompt. If omitted, random prompts are generated.")
|
|
246
|
+
ap.add_argument("--count", type=int, default=8, help="How many images to generate.")
|
|
247
|
+
ap.add_argument("--model", default="gpt-image-1", help="Image model id.")
|
|
248
|
+
ap.add_argument("--size", default="", help="Image size (e.g. 1024x1024, 1536x1024). Defaults based on model if not specified.")
|
|
249
|
+
ap.add_argument("--quality", default="", help="Image quality (e.g. high, standard). Defaults based on model if not specified.")
|
|
250
|
+
ap.add_argument("--background", default="", help="Background transparency (GPT models only): transparent, opaque, or auto.")
|
|
251
|
+
ap.add_argument("--output-format", default="", help="Output format (GPT models only): png, jpeg, or webp.")
|
|
252
|
+
ap.add_argument("--style", default="", help="Image style (dall-e-3 only): vivid or natural.")
|
|
253
|
+
ap.add_argument("--out-dir", default="", help="Output directory (default: ./tmp/openai-image-gen-<ts>).")
|
|
254
|
+
args = ap.parse_args()
|
|
255
|
+
|
|
256
|
+
api_key = (os.environ.get("OPENAI_API_KEY") or "").strip()
|
|
257
|
+
if not api_key:
|
|
258
|
+
print("Missing OPENAI_API_KEY", file=sys.stderr)
|
|
259
|
+
return 2
|
|
260
|
+
|
|
261
|
+
# Apply model-specific defaults if not specified
|
|
262
|
+
default_size, default_quality = get_model_defaults(args.model)
|
|
263
|
+
size = args.size or default_size
|
|
264
|
+
quality = args.quality or default_quality
|
|
265
|
+
|
|
266
|
+
count = args.count
|
|
267
|
+
if args.model == "dall-e-3" and count > 1:
|
|
268
|
+
print(f"Warning: dall-e-3 only supports generating 1 image at a time. Reducing count from {count} to 1.", file=sys.stderr)
|
|
269
|
+
count = 1
|
|
270
|
+
|
|
271
|
+
out_dir = Path(args.out_dir).expanduser() if args.out_dir else default_out_dir()
|
|
272
|
+
out_dir.mkdir(parents=True, exist_ok=True)
|
|
273
|
+
|
|
274
|
+
prompts = [args.prompt] * count if args.prompt else pick_prompts(count)
|
|
275
|
+
|
|
276
|
+
try:
|
|
277
|
+
normalized_background = normalize_background(args.model, args.background)
|
|
278
|
+
normalized_style = normalize_style(args.model, args.style)
|
|
279
|
+
normalized_output_format = normalize_output_format(args.model, args.output_format)
|
|
280
|
+
except ValueError as e:
|
|
281
|
+
print(str(e), file=sys.stderr)
|
|
282
|
+
return 2
|
|
283
|
+
|
|
284
|
+
# Determine file extension based on output format
|
|
285
|
+
if args.model.startswith("gpt-image") and normalized_output_format:
|
|
286
|
+
file_ext = normalized_output_format
|
|
287
|
+
else:
|
|
288
|
+
file_ext = "png"
|
|
289
|
+
|
|
290
|
+
items: list[dict] = []
|
|
291
|
+
for idx, prompt in enumerate(prompts, start=1):
|
|
292
|
+
print(f"[{idx}/{len(prompts)}] {prompt}")
|
|
293
|
+
res = request_images(
|
|
294
|
+
api_key,
|
|
295
|
+
prompt,
|
|
296
|
+
args.model,
|
|
297
|
+
size,
|
|
298
|
+
quality,
|
|
299
|
+
normalized_background,
|
|
300
|
+
normalized_output_format,
|
|
301
|
+
normalized_style,
|
|
302
|
+
)
|
|
303
|
+
data = res.get("data", [{}])[0]
|
|
304
|
+
image_b64 = data.get("b64_json")
|
|
305
|
+
image_url = data.get("url")
|
|
306
|
+
if not image_b64 and not image_url:
|
|
307
|
+
raise RuntimeError(f"Unexpected response: {json.dumps(res)[:400]}")
|
|
308
|
+
|
|
309
|
+
filename = f"{idx:03d}-{slugify(prompt)[:40]}.{file_ext}"
|
|
310
|
+
filepath = out_dir / filename
|
|
311
|
+
if image_b64:
|
|
312
|
+
filepath.write_bytes(base64.b64decode(image_b64))
|
|
313
|
+
else:
|
|
314
|
+
try:
|
|
315
|
+
urllib.request.urlretrieve(image_url, filepath)
|
|
316
|
+
except urllib.error.URLError as e:
|
|
317
|
+
raise RuntimeError(f"Failed to download image from {image_url}: {e}") from e
|
|
318
|
+
|
|
319
|
+
items.append({"prompt": prompt, "file": filename})
|
|
320
|
+
|
|
321
|
+
(out_dir / "prompts.json").write_text(json.dumps(items, indent=2), encoding="utf-8")
|
|
322
|
+
write_gallery(out_dir, items)
|
|
323
|
+
print(f"\nWrote: {(out_dir / 'index.html').as_posix()}")
|
|
324
|
+
return 0
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
if __name__ == "__main__":
|
|
328
|
+
raise SystemExit(main())
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
"""Tests for openai-image-gen helpers."""
|
|
2
|
+
|
|
3
|
+
import tempfile
|
|
4
|
+
from pathlib import Path
|
|
5
|
+
|
|
6
|
+
import pytest
|
|
7
|
+
from gen import (
|
|
8
|
+
normalize_background,
|
|
9
|
+
normalize_output_format,
|
|
10
|
+
normalize_style,
|
|
11
|
+
write_gallery,
|
|
12
|
+
)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def test_normalize_background_allows_empty_for_non_gpt_models():
|
|
16
|
+
assert normalize_background("dall-e-3", "transparent") == ""
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def test_normalize_background_allows_empty_for_gpt_models():
|
|
20
|
+
assert normalize_background("gpt-image-1", "") == ""
|
|
21
|
+
assert normalize_background("gpt-image-1", " ") == ""
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def test_normalize_background_normalizes_case_for_gpt_models():
|
|
25
|
+
assert normalize_background("gpt-image-1", "TRANSPARENT") == "transparent"
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def test_normalize_background_warns_when_model_does_not_support_flag(capsys):
|
|
29
|
+
assert normalize_background("dall-e-3", "transparent") == ""
|
|
30
|
+
captured = capsys.readouterr()
|
|
31
|
+
assert "--background is only supported for gpt-image models" in captured.err
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def test_normalize_background_rejects_invalid_values():
|
|
35
|
+
with pytest.raises(ValueError, match="Invalid --background"):
|
|
36
|
+
normalize_background("gpt-image-1", "checkerboard")
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
def test_normalize_style_allows_empty_for_non_dalle3_models():
|
|
40
|
+
assert normalize_style("gpt-image-1", "vivid") == ""
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
def test_normalize_style_allows_empty_for_dalle3():
|
|
44
|
+
assert normalize_style("dall-e-3", "") == ""
|
|
45
|
+
assert normalize_style("dall-e-3", " ") == ""
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def test_normalize_style_normalizes_case_for_dalle3():
|
|
49
|
+
assert normalize_style("dall-e-3", "NATURAL") == "natural"
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def test_normalize_style_warns_when_model_does_not_support_flag(capsys):
|
|
53
|
+
assert normalize_style("gpt-image-1", "vivid") == ""
|
|
54
|
+
captured = capsys.readouterr()
|
|
55
|
+
assert "--style is only supported for dall-e-3" in captured.err
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
def test_normalize_style_rejects_invalid_values():
|
|
59
|
+
with pytest.raises(ValueError, match="Invalid --style"):
|
|
60
|
+
normalize_style("dall-e-3", "cinematic")
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
def test_normalize_output_format_allows_empty_for_non_gpt_models():
|
|
64
|
+
assert normalize_output_format("dall-e-3", "jpeg") == ""
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
def test_normalize_output_format_allows_empty_for_gpt_models():
|
|
68
|
+
assert normalize_output_format("gpt-image-1", "") == ""
|
|
69
|
+
assert normalize_output_format("gpt-image-1", " ") == ""
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
def test_normalize_output_format_warns_when_model_does_not_support_flag(capsys):
|
|
73
|
+
assert normalize_output_format("dall-e-3", "jpeg") == ""
|
|
74
|
+
captured = capsys.readouterr()
|
|
75
|
+
assert "--output-format is only supported for gpt-image models" in captured.err
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
def test_normalize_output_format_normalizes_case_for_supported_values():
|
|
79
|
+
assert normalize_output_format("gpt-image-1", "PNG") == "png"
|
|
80
|
+
assert normalize_output_format("gpt-image-1", "WEBP") == "webp"
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
def test_normalize_output_format_strips_whitespace_for_supported_values():
|
|
84
|
+
assert normalize_output_format("gpt-image-1", " png ") == "png"
|
|
85
|
+
def test_normalize_output_format_keeps_supported_values():
|
|
86
|
+
assert normalize_output_format("gpt-image-1", "png") == "png"
|
|
87
|
+
assert normalize_output_format("gpt-image-1", "jpeg") == "jpeg"
|
|
88
|
+
assert normalize_output_format("gpt-image-1", "webp") == "webp"
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
def test_normalize_output_format_normalizes_jpg_alias():
|
|
92
|
+
assert normalize_output_format("gpt-image-1", "jpg") == "jpeg"
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
def test_normalize_output_format_rejects_invalid_values():
|
|
96
|
+
with pytest.raises(ValueError, match="Invalid --output-format"):
|
|
97
|
+
normalize_output_format("gpt-image-1", "svg")
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
def test_write_gallery_escapes_prompt_xss():
|
|
101
|
+
with tempfile.TemporaryDirectory() as tmpdir:
|
|
102
|
+
out = Path(tmpdir)
|
|
103
|
+
items = [{"prompt": '<script>alert("xss")</script>', "file": "001-test.png"}]
|
|
104
|
+
write_gallery(out, items)
|
|
105
|
+
html = (out / "index.html").read_text()
|
|
106
|
+
assert "<script>" not in html
|
|
107
|
+
assert "<script>" in html
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
def test_write_gallery_escapes_filename():
|
|
111
|
+
with tempfile.TemporaryDirectory() as tmpdir:
|
|
112
|
+
out = Path(tmpdir)
|
|
113
|
+
items = [{"prompt": "safe prompt", "file": '" onload="alert(1)'}]
|
|
114
|
+
write_gallery(out, items)
|
|
115
|
+
html = (out / "index.html").read_text()
|
|
116
|
+
assert 'onload="alert(1)"' not in html
|
|
117
|
+
assert """ in html
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
def test_write_gallery_escapes_ampersand():
|
|
121
|
+
with tempfile.TemporaryDirectory() as tmpdir:
|
|
122
|
+
out = Path(tmpdir)
|
|
123
|
+
items = [{"prompt": "cats & dogs <3", "file": "001-test.png"}]
|
|
124
|
+
write_gallery(out, items)
|
|
125
|
+
html = (out / "index.html").read_text()
|
|
126
|
+
assert "cats & dogs <3" in html
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
def test_write_gallery_normal_output():
|
|
130
|
+
with tempfile.TemporaryDirectory() as tmpdir:
|
|
131
|
+
out = Path(tmpdir)
|
|
132
|
+
items = [
|
|
133
|
+
{"prompt": "a lobster astronaut, golden hour", "file": "001-lobster.png"},
|
|
134
|
+
{"prompt": "a cozy reading nook", "file": "002-nook.png"},
|
|
135
|
+
]
|
|
136
|
+
write_gallery(out, items)
|
|
137
|
+
html = (out / "index.html").read_text()
|
|
138
|
+
assert "a lobster astronaut, golden hour" in html
|
|
139
|
+
assert 'src="001-lobster.png"' in html
|
|
140
|
+
assert "002-nook.png" in html
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: openai-whisper
|
|
3
|
+
description: Local speech-to-text with the Whisper CLI (no API key).
|
|
4
|
+
homepage: https://openai.com/research/whisper
|
|
5
|
+
metadata:
|
|
6
|
+
{
|
|
7
|
+
"quantumclaw":
|
|
8
|
+
{
|
|
9
|
+
"emoji": "š¤",
|
|
10
|
+
"requires": { "bins": ["whisper"] },
|
|
11
|
+
"install":
|
|
12
|
+
[
|
|
13
|
+
{
|
|
14
|
+
"id": "brew",
|
|
15
|
+
"kind": "brew",
|
|
16
|
+
"formula": "openai-whisper",
|
|
17
|
+
"bins": ["whisper"],
|
|
18
|
+
"label": "Install OpenAI Whisper (brew)",
|
|
19
|
+
},
|
|
20
|
+
],
|
|
21
|
+
},
|
|
22
|
+
}
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
# Whisper (CLI)
|
|
26
|
+
|
|
27
|
+
Use `whisper` to transcribe audio locally.
|
|
28
|
+
|
|
29
|
+
Quick start
|
|
30
|
+
|
|
31
|
+
- `whisper /path/audio.mp3 --model medium --output_format txt --output_dir .`
|
|
32
|
+
- `whisper /path/audio.m4a --task translate --output_format srt`
|
|
33
|
+
|
|
34
|
+
Notes
|
|
35
|
+
|
|
36
|
+
- Models download to `~/.cache/whisper` on first run.
|
|
37
|
+
- `--model` defaults to `turbo` on this install.
|
|
38
|
+
- Use smaller models for speed, larger for accuracy.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: openai-whisper-api
|
|
3
|
+
description: Transcribe audio via OpenAI Audio Transcriptions API (Whisper).
|
|
4
|
+
homepage: https://platform.openai.com/docs/guides/speech-to-text
|
|
5
|
+
metadata:
|
|
6
|
+
{
|
|
7
|
+
"quantumclaw":
|
|
8
|
+
{
|
|
9
|
+
"emoji": "š",
|
|
10
|
+
"requires": { "bins": ["curl"], "env": ["OPENAI_API_KEY"] },
|
|
11
|
+
"primaryEnv": "OPENAI_API_KEY",
|
|
12
|
+
},
|
|
13
|
+
}
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# OpenAI Whisper API (curl)
|
|
17
|
+
|
|
18
|
+
Transcribe an audio file via OpenAIās `/v1/audio/transcriptions` endpoint.
|
|
19
|
+
|
|
20
|
+
## Quick start
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
{baseDir}/scripts/transcribe.sh /path/to/audio.m4a
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defaults:
|
|
27
|
+
|
|
28
|
+
- Model: `whisper-1`
|
|
29
|
+
- Output: `<input>.txt`
|
|
30
|
+
|
|
31
|
+
## Useful flags
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
{baseDir}/scripts/transcribe.sh /path/to/audio.ogg --model whisper-1 --out /tmp/transcript.txt
|
|
35
|
+
{baseDir}/scripts/transcribe.sh /path/to/audio.m4a --language en
|
|
36
|
+
{baseDir}/scripts/transcribe.sh /path/to/audio.m4a --prompt "Speaker names: Peter, Daniel"
|
|
37
|
+
{baseDir}/scripts/transcribe.sh /path/to/audio.m4a --json --out /tmp/transcript.json
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## API key
|
|
41
|
+
|
|
42
|
+
Set `OPENAI_API_KEY`, or configure it in `~/.quantumclaw/quantumclaw.json`:
|
|
43
|
+
|
|
44
|
+
```json5
|
|
45
|
+
{
|
|
46
|
+
skills: {
|
|
47
|
+
"openai-whisper-api": {
|
|
48
|
+
apiKey: "OPENAI_KEY_HERE",
|
|
49
|
+
},
|
|
50
|
+
},
|
|
51
|
+
}
|
|
52
|
+
```
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
set -euo pipefail
|
|
3
|
+
|
|
4
|
+
usage() {
|
|
5
|
+
cat >&2 <<'EOF'
|
|
6
|
+
Usage:
|
|
7
|
+
transcribe.sh <audio-file> [--model whisper-1] [--out /path/to/out.txt] [--language en] [--prompt "hint"] [--json]
|
|
8
|
+
EOF
|
|
9
|
+
exit 2
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
if [[ "${1:-}" == "" || "${1:-}" == "-h" || "${1:-}" == "--help" ]]; then
|
|
13
|
+
usage
|
|
14
|
+
fi
|
|
15
|
+
|
|
16
|
+
in="${1:-}"
|
|
17
|
+
shift || true
|
|
18
|
+
|
|
19
|
+
model="whisper-1"
|
|
20
|
+
out=""
|
|
21
|
+
language=""
|
|
22
|
+
prompt=""
|
|
23
|
+
response_format="text"
|
|
24
|
+
|
|
25
|
+
while [[ $# -gt 0 ]]; do
|
|
26
|
+
case "$1" in
|
|
27
|
+
--model)
|
|
28
|
+
model="${2:-}"
|
|
29
|
+
shift 2
|
|
30
|
+
;;
|
|
31
|
+
--out)
|
|
32
|
+
out="${2:-}"
|
|
33
|
+
shift 2
|
|
34
|
+
;;
|
|
35
|
+
--language)
|
|
36
|
+
language="${2:-}"
|
|
37
|
+
shift 2
|
|
38
|
+
;;
|
|
39
|
+
--prompt)
|
|
40
|
+
prompt="${2:-}"
|
|
41
|
+
shift 2
|
|
42
|
+
;;
|
|
43
|
+
--json)
|
|
44
|
+
response_format="json"
|
|
45
|
+
shift 1
|
|
46
|
+
;;
|
|
47
|
+
*)
|
|
48
|
+
echo "Unknown arg: $1" >&2
|
|
49
|
+
usage
|
|
50
|
+
;;
|
|
51
|
+
esac
|
|
52
|
+
done
|
|
53
|
+
|
|
54
|
+
if [[ ! -f "$in" ]]; then
|
|
55
|
+
echo "File not found: $in" >&2
|
|
56
|
+
exit 1
|
|
57
|
+
fi
|
|
58
|
+
|
|
59
|
+
if [[ "${OPENAI_API_KEY:-}" == "" ]]; then
|
|
60
|
+
echo "Missing OPENAI_API_KEY" >&2
|
|
61
|
+
exit 1
|
|
62
|
+
fi
|
|
63
|
+
|
|
64
|
+
if [[ "$out" == "" ]]; then
|
|
65
|
+
base="${in%.*}"
|
|
66
|
+
if [[ "$response_format" == "json" ]]; then
|
|
67
|
+
out="${base}.json"
|
|
68
|
+
else
|
|
69
|
+
out="${base}.txt"
|
|
70
|
+
fi
|
|
71
|
+
fi
|
|
72
|
+
|
|
73
|
+
mkdir -p "$(dirname "$out")"
|
|
74
|
+
|
|
75
|
+
curl -sS https://api.openai.com/v1/audio/transcriptions \
|
|
76
|
+
-H "Authorization: Bearer $OPENAI_API_KEY" \
|
|
77
|
+
-H "Accept: application/json" \
|
|
78
|
+
-F "file=@${in}" \
|
|
79
|
+
-F "model=${model}" \
|
|
80
|
+
-F "response_format=${response_format}" \
|
|
81
|
+
${language:+-F "language=${language}"} \
|
|
82
|
+
${prompt:+-F "prompt=${prompt}"} \
|
|
83
|
+
>"$out"
|
|
84
|
+
|
|
85
|
+
echo "$out"
|