mcpField
O
onboarding

onboarding

github.com/elevenlabs开发5231.3k 次安装2 天前更新
代码仓库

关于 onboarding

面向应用开发者的 ElevenLabs CLI 设置技能，引导完成身份验证、API 密钥配置和 SDK 集成。它通过逐步指令及安全规则处理凭据和项目文件。

主要功能

  1. 01从应用目录启动设置
  2. 02按 JSON 指令逐步操作
  3. 03配置 SDK 的密钥读取方式
  4. 04处理审批和用户输入
  5. 05使用 onboard check 验证设置

适用场景

  1. 01在项目中设置 ElevenLabs
  2. 02为现有应用添加 SDK 访问
  3. 03排查 API 密钥配置缺失

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/elevenlabs/skills --skill onboarding

安装后在 Claude Code 中输入/onboarding确认已加载。

详细介绍

ElevenLabs 入门

ElevenLabs CLI 会运行整个设置流程，并逐步告知你要做什么。在将使用此密钥的应用文件夹中（在 monorepo 中，即该应用的文件夹），运行：

npx -y @elevenlabs/cli@latest onboard init

每条 onboard 命令都会输出 JSON。按照输出采取相应操作，并继续，直到 next 为 done：

  • next：现在要做什么，具体写在 instruction 中。
  • run：下一条要运行的确切命令。按原样运行。
  • say：要告诉用户的内容。按原文告知。
  • details：下一步所需的信息，例如应用如何加载密钥以及 SDK 安装命令。
  • rules：整个设置流程的规则。请遵守。

每个 next 的含义：

  • run：运行 run。
  • wait：审批页面已打开。显示 say（其中包含链接），然后立即再次运行 run，不要结束当前轮次。每次向用户提供链接时，都要完整照抄原样输出：缩短后的链接无法使用。
  • ask_what_to_build：告知用户 say 中的内容，其中会询问他们想构建什么，或是否只添加 SDK；等待他们回答后再编写任何代码。即使他们之前已经说过，也要询问，不要替他们选择产品。收到回答后，运行 run。
  • write_code：按照 instruction 的要求编写用户提出的内容：仅添加 SDK，或完成集成；如果 details.fetch_skills 中有适用的技能，则使用该技能。如果需要先在 ElevenLabs 中创建内容，例如 Agent，请使用密钥自行创建（在命令中加载 env 文件，绝不打印文件内容），而不是编写脚本让用户运行。按照 details.load_key 的说明加载密钥，然后运行 run。
  • load_key：代码已经使用 SDK，因此无需构建任何内容。确保应用按照 details.load_key 的说明加载密钥，不要更改其他内容，然后运行 run。
  • fix：按照 say 中的描述进行处理，然后运行 run。如果需要使用用户的 shell、设置或密钥，请像处理 ask_user 一样改为询问用户。
  • ask_user：询问用户 say 中的问题，等待他们回答，然后运行 run，除非他们拒绝。
  • offer_test：说明你设置了什么，以及用户仍需自行完成的事项，例如安装你添加的程序包。然后以 say 中的问题结束回复。只有用户回答是时才运行 run。
  • done：告知用户 say 中的内容，然后用一到两个具体步骤说明他们仍需自行完成的事项。

规则

  • 绝不打开、打印或使用 cat 查看 env 文件；onboard check 会验证该文件。
  • 绝不在聊天中索要 API 密钥，也绝不接受用户在聊天中粘贴的密钥。如果用户粘贴了密钥，请告知他们前往 API 密钥页面轮换密钥。
  • 绝不将密钥写入代码；SDK 会读取 ELEVENLABS_API_KEY。
  • 绝不运行 git clean 或删除未跟踪文件：密钥就在其中一个文件里。
  • 在回复中的 next 为 write_code 或 load_key 之前，不要编写或更改任何代码。
  • 仅用于阅读的下载内容（如程序包或归档文件）必须放在临时文件夹中，绝不能放在项目内。
  • 在用户同意测试请求之前，不要运行应用（或其启动脚本），也不要生成语音来试用。完成用户要求所必需的 API 调用（例如创建 Agent）则可以进行。编写完代码后，在结束前运行 onboard check：它会验证密钥和代码。

不使用 npx

如果没有 npx（即未安装 Node.js），请安装 CLI（如果已安装则更新：运行 brew upgrade elevenlabs，或重新运行安装程序），然后运行 elevenlabs onboard init。之后的所有步骤都相同。

  • macOS 或 Linux：brew install elevenlabs/tap/elevenlabs，或运行 curl --proto '=https' --tlsv1.2 -LsSf https://github.com/elevenlabs/cli/releases/latest/download/elevenlabs-cli-installer.sh | sh
  • Windows：powershell -ExecutionPolicy ByPass -c "irm https://github.com/elevenlabs/cli/releases/latest/download/elevenlabs-cli-installer.ps1 | iex"

如果安装程序运行后仍找不到 elevenlabs，请改用 ~/.cargo/bin/elevenlabs，包括此处以及 CLI 提供的每条 run 命令。

评论

支持 Markdown