@workos/skills

面向 AI 编码代理的 WorkOS 技能。包含两项技能和 40 个参考文件，涵盖 AuthKit、SSO、Directory Sync、RBAC、Vault、Migrations、后端 SDK 等。

作为 Claude Code 插件安装

npx skills add workos/skills

这将安装两个技能：workos 和 workos-widgets。workos 技能充当路由器，会根据您的任务自动加载正确的参考文档（AuthKit 配置、SSO、迁移等），因此您无需单独安装参考文档。

支持 Claude Code、Codex、Goose 以及任何支持 skills.sh 格式的代理。

作为 Cursor 插件安装

从 Cursor Marketplace（搜索 "WorkOS"）安装，或在本地克隆并创建符号链接——请参阅下文 Local Development。

作为 npm 包安装

用于以编程方式访问技能/参考内容（例如，从 WorkOS CLI）：

npm install @workos/skills

import { getReference, getSkill } from '@workos/skills';

// Read reference content directly
const content = await getReference('workos-authkit-nextjs');

// Read a skill's SKILL.md content
const router = await getSkill('workos');

Path helpers 也可供需要文件路径的使用者使用（例如，skill discovery）：

import { getReferencePath, getSkillsDir, getSkillPath } from '@workos/skills';

const refPath = getReferencePath('workos-authkit-nextjs'); // absolute path to .md file
const skillsDir = getSkillsDir(); // directory containing workos/ and workos-widgets/
const skillPath = getSkillPath('workos'); // absolute path to SKILL.md

导出

函数	返回值
`getReference(name)`	`Promise<string>` — 参考文件内容
`getSkill(skillName)`	`Promise<string>` — 技能 SKILL.md 内容
`getReferencePath(name)`	`references/{name}.md` 的绝对路径
`getSkillsDir()`	`skills/` 目录的绝对路径
`getSkillPath(skillName)`	`skills/{skillName}/SKILL.md` 的绝对路径

技能

两个已注册的技能：

技能	描述
`workos`	路由器 — 根据用户任务识别应加载哪个参考
`workos-widgets`	多框架小部件集成，支持按需查询 OpenAPI 规范

其余均为 references/ 下的参考文件。路由器通过渐进式披露将请求分发至正确的参考。

参考

注意： 参考不是独立技能。它们由 workos 技能根据您的任务自动加载。您无需单独安装它们。

完整参考列表（40+ 文件）

AuthKit 安装

参考	描述
`workos-authkit-nextjs`	Next.js App Router 集成
`workos-authkit-react`	React SPA 集成
`workos-authkit-react-router`	React Router v6/v7 集成
`workos-authkit-tanstack-start`	TanStack Start 集成
`workos-authkit-sveltekit`	SvelteKit 集成
`workos-authkit-vanilla-js`	原生 JS 集成
`workos-authkit-base`	AuthKit 架构参考

后端 SDK 安装

参考	描述
`workos-node`	Node.js (Express/Fastify/Hono/Koa)
`workos-python`	Python (Django/Flask/FastAPI)
`workos-dotnet`	.NET (ASP.NET Core)
`workos-go`	Go
`workos-ruby`	Ruby (Rails)
`workos-php`	PHP
`workos-php-laravel`	PHP Laravel
`workos-kotlin`	Kotlin
`workos-elixir`	Elixir

功能

Reference	Description
`workos-sso`	基于 SAML/OIDC 的单点登录
`workos-directory-sync`	从 IdP 同步用户目录
`workos-rbac`	基于角色的访问控制
`workos-vault`	加密数据存储
`workos-events`	Webhook 事件处理
`workos-audit-logs`	合规性审计日志
`workos-admin-portal`	自助管理门户
`workos-mfa`	多因素身份验证
`workos-custom-domains`	自定义域名配置
`workos-email`	邮件投递配置
`workos-integrations`	60+ IdP 集成的提供商查找表

Migrations

Reference	Description
`workos-migrate-auth0`	从 Auth0 迁移
`workos-migrate-firebase`	从 Firebase Auth 迁移
`workos-migrate-clerk`	从 Clerk 迁移
`workos-migrate-aws-cognito`	从 AWS Cognito 迁移
`workos-migrate-stytch`	从 Stytch 迁移
`workos-migrate-supabase-auth`	从 Supabase Auth 迁移
`workos-migrate-descope`	从 Descope 迁移
`workos-migrate-better-auth`	从 Better Auth 迁移
`workos-migrate-other-services`	从自定义认证迁移
`workos-migrate-the-standalone-sso-api`	将独立 SSO 升级为 AuthKit

API References

Reference	Description
`workos-api-authkit`	AuthKit/用户管理 API 端点
`workos-api-organization`	组织 API 端点

Management

Reference	Description
`workos-management`	CLI 资源管理（组织、用户、角色、Webhooks、数据填充）

开发

pnpm test          # vitest
pnpm lint          # oxlint
pnpm format        # oxfmt

本地 Cursor 开发

Cursor 从 ~/.cursor/plugins/local/ 加载本地插件。请为此仓库的插件目录创建符号链接，然后重新加载 Cursor：

ln -s "$(pwd)/plugins/workos" ~/.cursor/plugins/local/workos

然后在 Cursor 中：Cmd+Shift+P → Developer: Reload Window（如果重新加载未能识别新技能，则完全退出并重新启动 Cursor）。

Eval framework

衡量技能是否提升了 agent 生成的代码质量。每个用例分别在启用和未启用技能的情况下运行相同的 prompt，对两种输出进行评分，并报告差异。

pnpm eval -- --dry-run                        # verify cases load
pnpm eval -- --no-cache                       # full run (42 cases, ~$1.70)
pnpm eval -- --no-cache --case=sso-node-basic # single case
pnpm eval -- --no-cache --cases=sso-node-basic,sso-ruby-domain-routing # selected cases
pnpm eval -- --no-cache --fail-on-regression  # with gates
pnpm eval:risk -- --samples=8                 # rerun latest triage cases with saved samples

工作原理

每个参考文件都遵循相同的模式：

文档 URL — 权威来源链接（代理首先获取这些链接）
易错点 — LLM 从训练数据中容易出错的非显而易见的陷阱
端点（可选） — 用于快速参考的 API 端点表格

AuthKit 和后端 SDK 参考文档内容更丰富 — 它们包含逐步安装说明、决策树、验证清单和错误恢复。

路由器（workos/SKILL.md）将用户意图映射到正确的参考文件。

许可证

MIT