菜单
Explains the dev/test-studio Script Runner tool. Use when adding, editing, running, or documenting scripts in dev/test-studio/src/script-runner, or when the user mentions the Scripts tool, Studio runner scripts, script variables, or browser-side Sanity Studio scripts.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/sanity-io/plugins --skill test-studio-script-runner命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
基于 SOC 职业分类
正在显示 SKILL.md
| name | test-studio-script-runner |
| description | Explains the dev/test-studio Script Runner tool. Use when adding, editing, running, or documenting scripts in dev/test-studio/src/script-runner, or when the user mentions the Scripts tool, Studio runner scripts, script variables, or browser-side Sanity Studio scripts. |
Use this skill when working with the Scripts tool in dev/test-studio.
dev/test-studio/src/script-runner/index.tsxdev/test-studio/src/script-runner/ScriptRunnerTool.tsxdev/test-studio/src/script-runner/registry.tsdev/test-studio/src/script-runner/types.tsdev/test-studio/src/script-runner/scripts/*/index.tsdev/test-studio/src/script-runner/README.mdRead README.md and types.ts before changing the runner or adding scripts.
The runner is a Sanity Studio custom tool registered in the home workspace.
<studio>/home/scripts<studio>/home/scripts/<script-name>Scripts are browser-side TypeScript modules discovered at build time with Vite import.meta.glob.
They run inside Sanity Studio with the logged-in user's permissions and receive the Studio client.
Add a folder under dev/test-studio/src/script-runner/scripts/. The folder name should match the
script name. Put the registered entrypoint in index.ts; any helper files can live beside it.
scripts/
my-script-name/
index.ts
helpers.ts
Only scripts/*/index.ts files are discovered at build time.
import type {StudioScript} from '../../types'
const script: StudioScript = {
name: 'my-script-name',
title: 'My script name',
description: 'What this script does.',
apiVersion: '2026-03-01',
inputs: [
{
name: 'documentId',
title: 'Document ID',
defaultValue: 'example-id',
required: true,
},
],
async run({client, inputs, log}) {
log.info(`Running for ${inputs.documentId}`)
await client.fetch('*[_type == "post"][0...1]')
log.success('Done')
},
}
export default script
Script names must be unique and use lowercase letters, numbers, and hyphens. Keep the folder name
and script name aligned. The script name becomes the URL segment.
run() receives:
client: Sanity Studio client, configured with the script apiVersion or the runner default.inputs: string values from the run screen, keyed by input name.log: info, success, warning, and error methods that append output in the UI.signal: an AbortSignal reserved for script code that supports cancellation.Use inputs for string variables. Each input renders as a text field on the script run screen.
Required inputs disable the run button until non-empty.
Available input fields:
nametitledescriptiondefaultValueplaceholderrequiredAll values passed to scripts are strings. Validate and trim values inside run() when needed.
Script runner modules execute in the browser. Do not use:
fs, path, or other Node built-insprocess.exitSANITY_AUTH_TOKENDo not create a separate Sanity client from env vars. Use the provided client.
If a task needs Node-only APIs or token-based CLI behavior, keep it in dev/test-studio/scripts/
instead of the Studio script runner.
After changing the runner or adding scripts, run:
pnpm lint
pnpm --filter test-studio build
If pnpm --filter test-studio build fails because workspace package dist output is missing, build
with dependencies first:
pnpm --filter test-studio... build