/install turnstile-spin
Turnstile Spin skill
Turns the prompt "set up Turnstile" into a working end-to-end integration: a widget, a deployed managed siteverify Worker, frontend snippets at every chosen insertion point, and a real validation pass before reporting success.
You are the agent. Run the wizard below by invoking the scripts under scripts/ and branching on their JSON output. The scripts hold the deterministic logic (API calls, retry/error handling); your job is orchestration, codebase reading, confirmation, and the frontend edits.
Canonical instructions live at developers.cloudflare.com/turnstile/spin. If the docs page and this file disagree, trust the docs page.
When to load this skill
Load when the user's prompt mentions any of:
- "Turnstile", "CAPTCHA", "bot protection"
- "siteverify", "cf-turnstile-response"
- "protect this form", "stop bot signups", "spam signups"
- A specific signup, login, or contact form combined with "Cloudflare" or "bot"
Do not load for unrelated Cloudflare tasks (Workers, Pages, R2, etc.) unless Turnstile is also mentioned.
Conversation flow
The user pasted the prompt. You are in a multi-step dialog. Detect what you can, ask only when you have to, confirm before every irreversible step. Each numbered moment is one agent message. Items marked [wait for user] require a user response.
-
Brief acknowledge. One sentence: "I'll run Turnstile setup end to end. That's: check auth, scan the codebase, create the widget, deploy the Worker, wire the frontend, validate. Proceed?" [wait for user] Do NOT present a plan yet. Auth + scan come first.
-
Wrangler check.
npx wrangler --version. If missing, ask once: "Install wrangler withnpm install --save-dev wrangler(Node project) ornpm install -g wrangler(other)? Proceed?" [wait for user] If install is blocked entirely (corporate policy, blocked npm), fall back to driving Steps 4-5 viacurlagainstapi.cloudflare.com/client/v4/. -
Auth + scope probe (FIRST irreversible action). Run
scripts/auth-probe.sh. Branch onstatus:ok: continue to Step 4. The script already picked the account (single-account token, or one matching$CLOUDFLARE_ACCOUNT_ID).missing_token,missing_scope, ormissing_workers_scope: ask the user to create a token at https://dash.cloudflare.com/profile/api-tokens → Custom token → permissionsAccount.Turnstile:EditandAccount.Workers Scripts:Edit→ include the target account in Account Resources. Do NOT direct them towrangler login. Its OAuth scope doesn't includeAccount.Turnstile:EditorAccount.Workers Scripts:Edit. Offer three ways to hand the token over, cleanest first:- Export + relaunch (token never enters chat):
export CLOUDFLARE_API_TOKEN=\x3Ctoken>then restart the agent from that terminal. - Save to file (token in file with user-only perms, not in chat):
umask 077 && printf '%s' '\x3Ctoken>' > ~/.cf-turnstile-token, then read withTOKEN=$(cat ~/.cf-turnstile-token). - Paste in chat (fastest, but token lands in conversation log; user should rotate it after if the log is ever shared).
If the user picks option 3 (paste in chat), you can use the wait to run Steps 5, 6, 7 (Domain, Codebase scan, Insertion plan). Options 1 and 2 will restart your session, so do not pre-fetch state in those cases. When auth is established, re-run
auth-probe.sh, then continue to Step 8.
- Export + relaunch (token never enters chat):
multiple_accounts: the token covers more than one account and$CLOUDFLARE_ACCOUNT_IDis unset. Present the numberedaccountslist. [wait for user] Then exportCLOUDFLARE_ACCOUNT_ID=\x3Cchosen>and re-runauth-probe.sh.account_mismatch:$CLOUDFLARE_ACCOUNT_IDis set but isn't one of the token's accounts. Show theaccountslist and ask the user to eitherunset CLOUDFLARE_ACCOUNT_IDor set it to one of those IDs.
-
Account selection. If
auth-probe.shreturnedokafter amultiple_accountsround-trip, this is already done. Otherwise the script picked the single account silently and you continue to Step 5. -
Domain. Always include
localhostand127.0.0.1. For production, scanpackage.jsonhomepage,wrangler.toml,README.md,AGENTS.md, git remote. Confirm: "I'll register forlocalhost,127.0.0.1, and\x3Cdomain>. OK?" [wait for user] If no production domain is found, ask. -
Codebase scan. Detect framework + insertion candidates silently.
-
Insertion plan. Show the candidate list with
[recommended]/[skip by default]markers; ask the user to confirm (numbers, "all", "recommended", or a list). [wait for user] If an existing CAPTCHA was detected, present a migration plan instead (see "Migrating from another CAPTCHA"). -
Widget creation. Run
scripts/widget-create.sh --account-id \x3Cid> --name \x3Cname> --domains \x3Clist> --mode managed. Report the sitekey. The secret stays in env; never write it to disk. -
Worker deploy. Run
scripts/worker-deploy.sh --name turnstile-siteverify-\x3Cproject-slug>withWIDGET_SECRETexported. Report the Worker URL onstatus: ok. Onset_secret_failed, the Worker deployed butTURNSTILE_SECRET_KEYis not set on it; surface the error, then retry withecho "$WIDGET_SECRET" | npx wrangler secret put TURNSTILE_SECRET_KEY --name \x3Creturned worker_name>before running validation. -
Frontend edits. State the contract: "I'll add the widget + gate the existing submit handler on
success === true. The existing handler logic stays the same." Ask "yes" / "show". [wait for user] If "show", print unified diffs and ask again. Do NOT propose alternate behavior (mail delivery, custom backends). -
Validation. Run
scripts/validate.sh. Report each check as it passes. If any fails, surface the error and stop. [wait for user if anything fails] -
Persist skill. Ask: "Save the Spin skill to
.claude/skills/turnstile-spin/SKILL.mdso I can reuse it on follow-up tasks?" Default yes. [wait for user] Then runscripts/persist-skill.sh --path \x3Cagent-specific-path>. -
Final report. Print the structured summary: what was created, what was validated, what to do next.
Things you must NOT do
- Do not write the Turnstile secret to disk. Only pass it via stdin to
wrangler secret put(the worker-deploy.sh script handles this). - Do not skip validation.
- Do not overwrite files without showing a diff.
- Do not deploy a Worker to a different account than the widget was created in.
- Do not call siteverify from the browser. Always: browser → user's Worker → siteverify.
- Do not use
sudoor install global packages without asking.
Hard scope boundary: DO NOT ask the user about
Spin validates the Turnstile token via a managed Worker before the user's existing form handler runs. Everything else is out of scope:
- Email / SMS / notification delivery. Leave the existing submit handler alone (just gate it on
success === true). Don't propose Resend, Mailchannels, SMTP, mailto. - Custom Worker code. Deploy the stock Worker template bundled at
templates/worker/. Don't write a new Worker. Don't add features (rate limiting, custom routing, third-party integrations). - Database / payment / OAuth / form persistence. Out of scope.
- Frontend framework migration, refactoring, or styling. Edit only what's needed.
- reCAPTCHA v3 score thresholds. Turnstile returns
success: true/false. - Pre-clearance-only setups. If
clearance_level !== no_clearance, siteverify is optional and Spin doesn't apply. Redirect the user and exit.
Recovery flow: respect existing widget configuration
If the user tells you they already have a Turnstile widget set up and want to wire siteverify to it without rotating the sitekey (e.g. "I have a sitekey but siteverify never worked", "set up Spin against my existing widget \x3Csitekey>"):
- Skip Step 8 (widget creation). The sitekey already exists; get it from the user.
- Fetch the widget metadata via
scripts/fetch-secret.sh --account-id \x3Cid> --sitekey \x3Ckey>. Branch onstatus:ok: readsecret,clearance_level, anddomainsfrom the response. Confirmdomainsincludes the user's production hostname; if not, surface the gap before proceeding.missing_read_scope: tell the user to addAccount.Turnstile:Readto the token, or fall back to asking them to paste the secret. In the paste path, you do not haveclearance_levelordomains; ask the user to confirm both.
- Check
clearance_levelfrom the response (or the user's answer):no_clearance: standard recovery (deploy Worker, wire siteverify).- anything else: ask whether they want siteverify on top of pre-clearance, or exit per the scope boundary.
- Continue from Step 9 (Worker deploy). Site key does not change. Dashboard's
Deploymentcolumn flips fromManualtoSpinon the first request carryingdata-action="turnstile-spin-v1". - Never recreate the widget to get a fresh secret. That breaks the existing sitekey everywhere it's deployed.
The frontend-edit contract
When wiring an existing form to the Worker (Step 10), the contract is: gate, don't replace. The user's existing submit handler keeps doing what it did. Spin only adds a validation step before it.
form.addEventListener("submit", async (e) => {
e.preventDefault();
const token = /* read cf-turnstile-response */;
const result = await fetch(WORKER_URL, { method: 'POST', body: JSON.stringify({ token }) });
const data = await result.json();
if (!data.success) return; // show failure
// existing handler logic runs here, unchanged
});
If the existing handler was a stub, Spin leaves it a stub gated on success. The user can replace the stub later; that's not Spin's job.
Migrating from another CAPTCHA
During the Step 6 codebase scan, also look for existing reCAPTCHA or hCaptcha. If found, switch Step 7 to a migration plan.
Detection signals:
- reCAPTCHA:
https://www.google.com/recaptcha/api.js,class="g-recaptcha",data-sitekey="6L...", backend POST to/recaptcha/api/siteverify - hCaptcha:
https://js.hcaptcha.com/1/api.js,class="h-captcha", backend POST tohttps://hcaptcha.com/siteverify
Substitution:
- Replace script tags with
https://challenges.cloudflare.com/turnstile/v0/api.js(async defer). - Replace
class="g-recaptcha"/class="h-captcha"divs withclass="cf-turnstile", updatedata-sitekeyto the new Turnstile sitekey, adddata-action="turnstile-spin-v1". - Token field changes from
g-recaptcha-responsetocf-turnstile-response. - Backend siteverify URL points at the Spin-deployed Worker. Drop
RECAPTCHA_SECRET/HCAPTCHA_SECRETenv vars.
Edge cases to surface to the user:
- reCAPTCHA v3 score thresholds. Turnstile has no score. Tell the user explicitly that migrated code will reject on
success === false. - reCAPTCHA Enterprise. Don't auto-migrate. Point at developers.cloudflare.com/turnstile/migration/recaptcha/.
- Custom
action=values. Preserve any custom action the user passed togrecaptcha.executeasdata-actionon the widget. Useturnstile-spin-v1only when no custom action exists.
Edge cases
| Situation | Action |
|---|---|
wrangler not installed |
Install path: npm install --save-dev wrangler (Node project) or npm install -g wrangler (other) |
| Multiple Cloudflare accounts | scripts/auth-probe.sh returns all accounts; ask the user to choose, export CLOUDFLARE_ACCOUNT_ID |
| Cloudflare Pages project | Deploy the managed Worker anyway, OR suggest the Pages Plugin |
EXPECTED_HOSTNAME mismatch |
Update widget domains via PUT, not PATCH (PATCH returns 10405 Method not allowed): curl -X PUT .../widgets/$SITEKEY -d '{"name":"...","mode":"managed","domains":[...]}' |
| Worker name conflict | worker-deploy.sh retries automatically with a hash suffix |
| Token expired mid-flow | Stop, re-run scripts/auth-probe.sh, prompt for fresh credentials |
Step 11 returns missing-input-secret |
Secret didn't propagate. Re-set: echo "$WIDGET_SECRET" | npx wrangler secret put TURNSTILE_SECRET_KEY --name \x3Cworker_name from worker-deploy.sh output>, wait 10s, re-validate. Use the worker_name field returned by worker-deploy.sh; do not rely on a $WORKER_NAME env var. |
worker-deploy.sh returns set_secret_failed |
Worker is deployed but secret is not set. Re-run only the secret-put using the returned worker_name: echo "$WIDGET_SECRET" | npx wrangler secret put TURNSTILE_SECRET_KEY --name \x3Cworker_name>. Surface the detail field to the user — it carries the wrangler error. |
Telemetry marker
Every snippet you write must include data-action="turnstile-spin-v1". Account-level aggregate telemetry, never per-user. Cloudflare uses it to measure activation. If the user removes the attribute, the integration still works; only the analytics segmentation is lost.
Do not
- Do not write the secret to disk.
- Do not skip validation (Step 11).
- Do not propose features outside the wizard (custom Worker code, custom domains, advanced WAF rules) unless asked.
- Do not call siteverify from the browser.
- Do not deploy the Worker into a different account than the widget.
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install turnstile-spin - 安装完成后,直接呼叫该 Skill 的名称或使用
/turnstile-spin触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
Turnstile Spin 是什么?
Set up Cloudflare Turnstile end-to-end in a project — scan the codebase, create the widget via the Cloudflare API, deploy the managed siteverify Worker, writ... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 22 次。
如何安装 Turnstile Spin?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install turnstile-spin」即可一键安装,无需额外配置。
Turnstile Spin 是免费的吗?
是的,Turnstile Spin 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
Turnstile Spin 支持哪些平台?
Turnstile Spin 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 Turnstile Spin?
由 Reza(@creativerezz)开发并维护,当前版本 v1.0.0。