@syngy/create-webskill 0.1.0

package/README.md

@@ -0,0 +1,9 @@
+# @syngy/create-webskill
+
+Create a BotWorks web skill package skeleton.
+
+```bash
+npm create @syngy/webskill web-skills/example -- --title "Example workflow" --domain example.com
+```
+
+Edit the generated files, then publish them from BotWorks with `browser_use.web_skill_publish`.

package/bin/create-webskill.js

@@ -0,0 +1,127 @@
+#!/usr/bin/env node
+import { mkdir, readdir, writeFile } from 'node:fs/promises'
+import path from 'node:path'
+
+function parseArgs(argv) {
+  const out = { filepath: '', title: '', domain: '' }
+  const rest = []
+  for (let i = 0; i < argv.length; i += 1) {
+    const arg = argv[i]
+    if (arg === '--title') {
+      out.title = argv[++i] || ''
+    } else if (arg === '--domain') {
+      out.domain = argv[++i] || ''
+    } else if (!arg.startsWith('--')) {
+      rest.push(arg)
+    }
+  }
+  out.filepath = rest[0] || ''
+  return out
+}
+
+function slugify(input) {
+  return input
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+}
+
+function filesFor({ title, domain }) {
+  const manifest = {
+    name: title,
+    description: `Reusable browser workflow for ${domain}.`,
+    domains: [domain],
+    pathPatterns: ['/**'],
+    entryPath: 'SKILL.md',
+    tools: []
+  }
+  return {
+    'SKILL.md': `# ${title}
+
+## 适用范围
+
+- Domain: \`${domain}\`
+- 默认匹配路径: \`/**\`
+
+## 成功链路
+
+把已经验证通过的浏览器操作步骤写在这里。步骤应包含入口页面、关键按钮或输入框、必要等待条件、完成后的可验证页面状态。
+
+## 脚本
+
+脚本文件放在 \`scripts/\` 下。需要暴露脚本工具时，在 \`manifest.json\` 的 \`tools\` 中增加工具名、说明、脚本路径和 inputSchema。
+
+脚本入口固定为:
+
+\`\`\`js
+async function run(args, context) {
+  return { result: { title: context.title, url: context.url } };
+}
+\`\`\`
+
+可用的页面工具在 \`scripts/README.md\`。
+`,
+    'manifest.json': `${JSON.stringify(manifest, null, 2)}\n`,
+    'scripts/README.md': `# pageTool
+
+Web skill scripts receive \`args\` and \`context\`.
+
+- \`context.url\`
+- \`context.title\`
+- \`context.store\`
+- \`context.pageTool\`
+
+Common calls:
+
+\`\`\`js
+await context.pageTool.element.click({ ref: "e1" })
+await context.pageTool.element.type({ ref: "e2" }, "hello")
+await context.pageTool.keyboard.press("Enter")
+const text = await context.pageTool.element.text({ ref: "e3" })
+const seen = await context.pageTool.visual.getViewportContent({ type: "object", properties: { title: { type: "string" } }, required: ["title"] })
+const code = await context.pageTool.visual.getImageContent({ ref: "e4" }, { type: "object", properties: { value: { type: "string" } }, required: ["value"] })
+\`\`\`
+
+Method groups:
+
+- \`page.url()\`, \`page.title()\`, \`page.viewport()\`, \`page.waitForLoadState(state)\`, \`page.waitForTimeout(ms)\`
+- \`keyboard.type(text)\`, \`keyboard.press(key)\`, \`keyboard.down(key)\`, \`keyboard.up(key)\`, \`keyboard.insertText(text)\`
+- \`mouse.move(x, y)\`, \`mouse.click(x, y)\`, \`mouse.dblclick(x, y)\`, \`mouse.down()\`, \`mouse.up()\`, \`mouse.wheel(deltaX, deltaY)\`
+- \`element.click(target)\`, \`element.hover(target)\`, \`element.type(target, text)\`, \`element.fill(target, value)\`, \`element.press(target, key)\`
+- \`element.text(target)\`, \`element.html(target)\`, \`element.box(target)\`, \`element.exists(target)\`
+- \`visual.getElementContent(target, schema)\`, \`visual.getViewportContent(schema)\`, \`visual.getImageContent(target, schema)\`
+`,
+    'scripts/example.js': `async function run(args, context) {
+  return { result: { title: context.title, url: context.url } };
+}
+`,
+    '.webskill/source.json': `${JSON.stringify({ source: 'init' }, null, 2)}\n`
+  }
+}
+
+async function main() {
+  const opts = parseArgs(process.argv.slice(2))
+  if (!opts.title || !opts.domain) {
+    console.error('Usage: npm create @syngy/webskill <filepath> -- --title <title> --domain <domain>')
+    process.exit(2)
+  }
+  const target = path.resolve(opts.filepath || path.join('web-skills', slugify(opts.title) || 'web-skill'))
+  await mkdir(target, { recursive: true })
+  const entries = await readdir(target)
+  if (entries.length > 0) {
+    console.error(`Target directory is not empty: ${target}`)
+    process.exit(2)
+  }
+  for (const [relative, content] of Object.entries(filesFor(opts))) {
+    const full = path.join(target, relative)
+    await mkdir(path.dirname(full), { recursive: true })
+    await writeFile(full, content, 'utf8')
+  }
+  console.log(`Created web skill package at ${target}`)
+}
+
+main().catch((err) => {
+  console.error(err instanceof Error ? err.message : String(err))
+  process.exit(1)
+})

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@syngy/create-webskill",
+  "version": "0.1.0",
+  "description": "Create a BotWorks web skill package skeleton",
+  "type": "module",
+  "bin": {
+    "create-webskill": "bin/create-webskill.js"
+  },
+  "files": [
+    "bin",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}