workflows-install
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseZapier Workflows Early Access Install
Zapier Workflows 早期访问安装指引
Imperative recipe. Each step gates the next. Do not skip a step that failed.
This is the public-first EA path. It uses the Zapier SDK CLI and does not install the legacy package.
@zapier/zapier-sdk-code-substrate强制步骤说明:每一步都是下一步的前提,请勿跳过失败的步骤。
这是面向公众的早期访问路径,使用Zapier SDK CLI,不会安装旧版包。
@zapier/zapier-sdk-code-substrateFlow
流程
mermaid
flowchart TD
probe["1. Probe environment"] --> envOk{"Node 18+, npm, git OK?"}
envOk -->|no| stopEnv["STOP: tell user what to install"]
envOk -->|yes| installCli["2. Install or update SDK CLI"]
installCli --> verifyExperimental["3. Verify experimental commands"]
verifyExperimental --> commandsOk{"Code Workflows commands visible?"}
commandsOk -->|no| stopCli["STOP: diagnose SDK CLI install"]
commandsOk -->|yes| checkAuth["4. Check Zapier auth"]
checkAuth --> authOk{"JSON has data and no errors?"}
authOk -->|no| login["4b. Ask user to run interactive login"]
login --> checkAuth
authOk -->|yes| checkAccess["5. Check Zapier Workflows EA access"]
checkAccess --> accessOk{"Read-only workflow list succeeds?"}
accessOk -->|no| stopAccess["STOP: closed beta access required"]
accessOk -->|yes| installSkills["6. Bootstrap companion skills"]
installSkills --> report["7. Report success and next steps"]mermaid
flowchart TD
probe["1. 探测环境"] --> envOk{"Node 18+, npm, git 正常?"}
envOk -->|否| stopEnv["终止:告知用户需要安装的工具"]
envOk -->|是| installCli["2. 安装或更新SDK CLI"]
installCli --> verifyExperimental["3. 验证实验性命令"]
verifyExperimental --> commandsOk{"Code Workflows命令可见?"}
commandsOk -->|否| stopCli["终止:排查SDK CLI安装问题"]
commandsOk -->|是| checkAuth["4. 检查Zapier身份验证"]
checkAuth --> authOk{"JSON包含数据且无错误?"}
authOk -->|否| login["4b. 要求用户运行交互式登录"]
login --> checkAuth
authOk -->|是| checkAccess["5. 检查Zapier Workflows早期访问权限"]
checkAccess --> accessOk{"只读工作流列表请求成功?"}
accessOk -->|否| stopAccess["终止:需要封闭测试访问权限"]
accessOk -->|是| installSkills["6. 引导安装配套技能"]
installSkills --> report["7. 报告成功结果及后续步骤"]What This Installs
本次安装内容
- — public npm package that provides
@zapier/zapier-sdk-cli@latest,zapier-sdk, andzapier-sdk-cli. Installed globally.zapier-sdk-experimental - Five companion skills installed through the CLI:
skills,workflows/doctor,workflows/create,workflows/list, andworkflows/history.workflows/modify
What this does not install:
- — old private CLI path. Do not install it for EA.
@zapier/zapier-sdk-code-substrate - globally. The create skill installs or pins it inside workflow projects when needed.
@zapier/zapier-durable
- — 提供
@zapier/zapier-sdk-cli@latest、zapier-sdk和zapier-sdk-cli的公开npm包,将全局安装。zapier-sdk-experimental - 通过CLI安装的五个配套技能:
skills、workflows/doctor、workflows/create、workflows/list和workflows/history。workflows/modify
本次不会安装的内容:
- — 旧版私有CLI路径,早期访问版本无需安装。
@zapier/zapier-sdk-code-substrate - 全局安装。create技能会在需要时在工作流项目内部安装或固定该包。
@zapier/zapier-durable
Step 1: Probe Environment
步骤1:探测环境
Run each check. If any fails, stop and tell the user how to fix it.
bash
node --version
npm --version
git --versionExpected output:
bash
v18.0.0 # or higher
10.x.x # npm version; any current version is fine
git version 2.x.xRequirements:
| Tool | Minimum version | Install if missing |
|---|---|---|
| Node | 18 | |
| npm | any current version | bundled with Node |
| git | any | usually preinstalled on macOS; otherwise |
If Node or npm is missing, explain that Node includes npm and the user needs a normal Node install before continuing. For macOS users, suggest either the Node LTS installer from , Homebrew (), or nvm if they already use it. Do not continue until and work.
nodejs.orgbrew install nodenode --versionnpm --versionIf git is missing, explain that git is needed only to download the companion skills from GitHub. For macOS users, suggest installing Apple Command Line Tools or Homebrew git. Do not continue until works.
git --version运行以下各项检查,若任何一项失败,需终止操作并告知用户修复方法。
bash
node --version
npm --version
git --version预期输出:
bash
v18.0.0 # 或更高版本
10.x.x # npm版本;任何当前版本均可
git version 2.x.x要求:
| 工具 | 最低版本 | 缺失时的安装方式 |
|---|---|---|
| Node | 18 | |
| npm | 任何当前版本 | 随Node捆绑安装 |
| git | 任意版本 | macOS通常预装;否则使用 |
若缺失Node或npm,需说明Node包含npm,用户需先完成标准Node安装再继续。对于macOS用户,建议从下载Node LTS安装包、使用Homebrew(),或如果已使用nvm则通过nvm安装。需等到和命令可正常运行后再继续。
nodejs.orgbrew install nodenode --versionnpm --version若缺失git,需说明git仅用于从GitHub下载配套技能。对于macOS用户,建议安装Apple命令行工具或Homebrew git。需等到命令可正常运行后再继续。
git --versionStep 2: Install Or Update The Zapier SDK CLI
步骤2:安装或更新Zapier SDK CLI
Check for an existing binary and the latest published CLI version:
bash
which zapier-sdk
zapier-sdk --version
npm view @zapier/zapier-sdk-cli versionIf is missing, install the CLI globally:
zapier-sdkbash
npm install -g @zapier/zapier-sdk-cli@latestIf already exists, compare the installed version from with the latest version from . If they differ, update the CLI:
zapier-sdkzapier-sdk --versionnpm view @zapier/zapier-sdk-cli versionbash
npm install -g @zapier/zapier-sdk-cli@latestAfter updating, rerun:
bash
zapier-sdk --version
npm view @zapier/zapier-sdk-cli versionContinue only when the installed CLI version matches the latest published version.
@zapier/zapier-sdk-cliVerify the binary is on PATH:
bash
which zapier-sdk
zapier-sdk --versionIf global npm installs fail because of permissions, tell the user to fix their Node/npm setup before retrying. Prefer a user-owned Node install through nvm or Homebrew over .
sudo npm install -g检查现有二进制文件及最新发布的CLI版本:
bash
which zapier-sdk
zapier-sdk --version
npm view @zapier/zapier-sdk-cli version若不存在,全局安装CLI:
zapier-sdkbash
npm install -g @zapier/zapier-sdk-cli@latest若已存在,对比的已安装版本与的最新版本。若版本不同,更新CLI:
zapier-sdkzapier-sdk --versionnpm view @zapier/zapier-sdk-cli versionbash
npm install -g @zapier/zapier-sdk-cli@latest更新后,重新运行:
bash
zapier-sdk --version
npm view @zapier/zapier-sdk-cli version仅当已安装的CLI版本与最新发布的版本一致时,方可继续。
@zapier/zapier-sdk-cli验证二进制文件是否在PATH中:
bash
which zapier-sdk
zapier-sdk --version若全局npm安装因权限失败,需告知用户先修复Node/npm配置后重试。优先推荐通过nvm或Homebrew进行用户级Node安装,而非使用。
sudo npm install -gStep 3: Verify Code Workflows Experimental Commands
步骤3:验证Code Workflows实验性命令
bash
zapier-sdk --experimental --help
zapier-sdk --experimental create-workflow --help
zapier-sdk --experimental publish-workflow-version --help
zapier-sdk --experimental run-durable --help
zapier-sdk --experimental list-triggers --help
zapier-sdk --experimental get-workflow-run --help
zapier-sdk --experimental trigger-workflow --help
zapier-sdk --experimental list-workflow-drafts --help
zapier-sdk --experimental publish-workflow-draft --helpExpected output includes the Code Workflows command group, including commands such as:
text
create-workflow
list-workflows
run-durable
publish-workflow-version
list-workflow-runs
get-workflow-run
list-workflow-drafts
create-workflow-draft
get-workflow-draft
update-workflow-draft
publish-workflow-draft
discard-workflow-draftThe command-specific help must expose the flags the companion skills depend on:
- includes
create-workflow --help.--private - includes
publish-workflow-version --help,--connections, and--app-versions.--trigger - includes
update-workflow-draft --help.--draft-revision - includes
publish-workflow-draft --helpand--draft-revision.--enabled - includes
run-durable --helpand--connections.--private - succeeds.
list-triggers --help - succeeds.
get-workflow-run --help - includes
trigger-workflow --help.--input
The equivalent binary may also work:
bash
zapier-sdk-experimental --helpIf neither form exposes Code Workflows commands, stop and diagnose the SDK CLI install. Do not fall back to .
@zapier/zapier-sdk-code-substrateIf exists but the Code Workflows command group or required command-specific flags are missing, the user likely has an older SDK CLI. Run:
zapier-sdkbash
npm install -g @zapier/zapier-sdk-cli@latest
zapier-sdk --experimental --help
zapier-sdk --experimental publish-workflow-version --helpRetry the command-specific help checks once after updating. Proceed only after the Code Workflows command group and required flags are visible. If the required flags are still missing after updating, stop and report the installed CLI version and latest npm version; do not install companion skills into a workspace that cannot run their documented command shapes.
bash
zapier-sdk --experimental --help
zapier-sdk --experimental create-workflow --help
zapier-sdk --experimental publish-workflow-version --help
zapier-sdk --experimental run-durable --help
zapier-sdk --experimental list-triggers --help
zapier-sdk --experimental get-workflow-run --help
zapier-sdk --experimental trigger-workflow --help
zapier-sdk --experimental list-workflow-drafts --help
zapier-sdk --experimental publish-workflow-draft --help预期输出应包含Code Workflows命令组,例如:
text
create-workflow
list-workflows
run-durable
publish-workflow-version
list-workflow-runs
get-workflow-run
list-workflow-drafts
create-workflow-draft
get-workflow-draft
update-workflow-draft
publish-workflow-draft
discard-workflow-draft命令的详细帮助需展示配套技能依赖的参数:
- 包含
create-workflow --help。--private - 包含
publish-workflow-version --help、--connections和--app-versions。--trigger - 包含
update-workflow-draft --help。--draft-revision - 包含
publish-workflow-draft --help和--draft-revision。--enabled - 包含
run-durable --help和--connections。--private - 可成功运行。
list-triggers --help - 可成功运行。
get-workflow-run --help - 包含
trigger-workflow --help。--input
等效二进制文件也可正常运行:
bash
zapier-sdk-experimental --help若两种方式均未展示Code Workflows命令,需终止操作并排查SDK CLI安装问题。请勿回退到。
@zapier/zapier-sdk-code-substrate若存在但Code Workflows命令组或所需命令参数缺失,说明用户可能使用旧版SDK CLI。运行:
zapier-sdkbash
npm install -g @zapier/zapier-sdk-cli@latest
zapier-sdk --experimental --help
zapier-sdk --experimental publish-workflow-version --help更新后重新进行命令帮助检查。仅当Code Workflows命令组及所需参数可见时,方可继续。若更新后所需参数仍缺失,需终止操作并报告已安装的CLI版本和最新npm版本;请勿在无法运行文档指定命令的工作区安装配套技能。
Step 4: Authenticate To Zapier
步骤4:Zapier身份验证
Check auth state first:
bash
zapier-sdk get-profile --jsonTreat auth as successful only if the JSON has a non-null object with an email and the array is empty. Do not rely on exit code alone; some SDK CLI auth failures return exit code 0 with errors in the JSON body.
dataerrorsExpected successful output includes the user's email:
json
{
"data": {
"email": "user@example.com"
},
"errors": []
}If is null, is non-empty, or the error message says authentication is required, stop and ask the user to run the interactive login command in a real terminal:
dataerrorsbash
zapier-sdk loginThis opens a browser. The CLI error text may suggest , but after the global install above the preferred command is . Do not run browser login inside a non-interactive shell or background process unless the user explicitly asks you to manage the interactive login. After the user finishes login, rerun and inspect the JSON again.
npx zapier-sdk loginzapier-sdk loginzapier-sdk get-profile --jsonFor Zapier employees, the normal path is to log in with their Zapier work account. For external-user testing, use the account that has been allowlisted for Zapier Workflows EA.
Do not ask the user for a Zapier password, API key, npm token, or copied auth token. Authentication should happen through the browser-based flow unless the user explicitly says they are using client credentials for automation.
zapier-sdk loginIf the user wants non-interactive auth for automation, note that the CLI error message may mention or client credential environment variables. For this EA install path, prefer browser login unless the user already has client credentials.
ZAPIER_CREDENTIALS先检查身份验证状态:
bash
zapier-sdk get-profile --json仅当JSON包含非空对象(含邮箱)且数组为空时,方可视为身份验证成功。请勿仅依赖退出码;部分SDK CLI身份验证失败会返回退出码0,但JSON主体包含错误信息。
dataerrors预期成功输出包含用户邮箱:
json
{
"data": {
"email": "user@example.com"
},
"errors": []
}若为空、非空,或错误信息提示需要身份验证,需终止操作并要求用户在真实终端中运行交互式登录命令:
dataerrorsbash
zapier-sdk login该命令会打开浏览器。CLI错误信息可能建议使用,但在完成全局安装后,优先推荐使用。除非用户明确要求管理交互式登录,否则请勿在非交互式shell或后台进程中运行浏览器登录。用户完成登录后,重新运行并再次检查JSON内容。
npx zapier-sdk loginzapier-sdk loginzapier-sdk get-profile --json对于Zapier员工,通常需使用Zapier工作账户登录。对于外部测试用户,需使用已加入Zapier Workflows早期访问白名单的账户。
请勿向用户索要Zapier密码、API密钥、npm令牌或复制的身份验证令牌。除非用户明确表示使用客户端凭据进行自动化操作,否则身份验证应通过基于浏览器的流程完成。
zapier-sdk login若用户需要用于自动化的非交互式身份验证,需注意CLI错误信息可能提及或客户端凭据环境变量。对于此早期访问安装路径,优先推荐浏览器登录,除非用户已拥有客户端凭据。
ZAPIER_CREDENTIALSStep 5: Check Zapier Workflows EA Access
步骤5:检查Zapier Workflows早期访问权限
After SDK profile auth succeeds, confirm the authenticated account has Zapier Workflows EA access with a read-only Code Workflows call:
bash
zapier-sdk --experimental list-workflows --jsonExpected output is JSON containing workflow data or an empty list, with no errors. This command should not create or modify cloud state.
Treat the access check as successful only if the JSON has workflow data or an empty workflow list and is empty. Do not rely on exit code alone; this command may return exit code 0 while the JSON body contains errors.
errorsIf the response says authentication is required, return to Step 4 and diagnose SDK auth.
If the response includes any of the following, treat it as a Zapier Workflows EA access failure and stop before installing companion skills:
None of the security schemes (userJwt) successfully authenticated this request- ,
allowlist, ornot allowlistednot whitelisted - ,
forbidden,permission, orunauthorizedaccess denied
When EA access fails, tell the user:
text
You're logged in to Zapier as <email>, and the Zapier SDK CLI is installed, but this account does not currently have Zapier Workflows EA access.
Zapier Workflows is currently only available to members of our closed beta.
To request access, fill out the beta sign-up form:
https://next-gen-zaps.zapier.app/
Submitting the form does not grant access immediately. The Zapier team will review your request and let you know once access has been granted.
After your account is allowlisted, rerun the workflows-install skill in this workspace. Reinstalling Node, npm, git, or the SDK CLI will not fix this access check.Use the email from in place of .
zapier-sdk get-profile --json<email>SDK账户身份验证成功后,通过只读Code Workflows调用确认已验证账户拥有Zapier Workflows早期访问权限:
bash
zapier-sdk --experimental list-workflows --json预期输出为包含工作流数据或空列表的JSON,且无错误信息。该命令不应创建或修改云端状态。
仅当JSON包含工作流数据或空工作流列表且为空时,方可视为权限检查成功。请勿仅依赖退出码;该命令可能返回退出码0,但JSON主体包含错误信息。
errors若响应提示需要身份验证,返回步骤4排查SDK身份验证问题。
若响应包含以下任意内容,视为Zapier Workflows早期访问权限失败,需在安装配套技能前终止操作:
None of the security schemes (userJwt) successfully authenticated this request- 、
allowlist或not allowlistednot whitelisted - 、
forbidden、permission或unauthorizedaccess denied
当早期访问权限失败时,告知用户:
text
您已以<email>身份登录Zapier,且Zapier SDK CLI已安装,但该账户目前暂无Zapier Workflows早期访问权限。
Zapier Workflows目前仅对封闭测试成员开放。
如需申请访问权限,请填写测试版注册表单:
https://next-gen-zaps.zapier.app/
提交表单并不意味着立即获得访问权限。Zapier团队会审核您的申请,获得权限后会通知您。
账户加入白名单后,请在当前工作区重新运行workflows-install技能。重新安装Node、npm、git或SDK CLI无法解决此权限检查问题。将中的邮箱替换。
zapier-sdk get-profile --json<email>Step 6: Bootstrap The Workflows Companion Skills
步骤6:引导安装工作流配套技能
Install the companion skills into the current workspace only after SDK auth and Zapier Workflows EA access are confirmed.
Use the public install path. The command runs the CLI; the skill content comes from the public GitHub repo after that repo is published.
skills.shnpxskillszapier/agent-skillsbash
npx skills add zapier/agent-skills --skill workflows-doctor --yes
npx skills add zapier/agent-skills --skill workflows-create --yes
npx skills add zapier/agent-skills --skill workflows-list --yes
npx skills add zapier/agent-skills --skill workflows-history --yes
npx skills add zapier/agent-skills --skill workflows-modify --yesVerify:
bash
npx skills list --jsonExpected output should include the installed workflows companion skills: , , , , and .
workflows-doctorworkflows-createworkflows-listworkflows-historyworkflows-modifyIf any companion skill is missing, rerun the specific command and diagnose before proceeding.
npx skills add ...Updates later use the standard CLI update path. If a companion skill detects SDK/skill drift, rerun or run ; those are the canonical repair paths.
skillsworkflows-installworkflows-doctorbash
npx skills update --project仅在SDK身份验证和Zapier Workflows早期访问权限确认后,方可在当前工作区安装配套技能。
使用公开的安装路径。命令运行 CLI;技能内容来自公开的GitHub仓库(需该仓库已发布)。
skills.shnpxskillszapier/agent-skillsbash
npx skills add zapier/agent-skills --skill workflows-doctor --yes
npx skills add zapier/agent-skills --skill workflows-create --yes
npx skills add zapier/agent-skills --skill workflows-list --yes
npx skills add zapier/agent-skills --skill workflows-history --yes
npx skills add zapier/agent-skills --skill workflows-modify --yes验证安装:
bash
npx skills list --json预期输出应包含已安装的工作流配套技能:、、、和。
workflows-doctorworkflows-createworkflows-listworkflows-historyworkflows-modify若任何配套技能缺失,重新运行对应的命令并排查问题后再继续。
npx skills add ...后续更新使用标准 CLI更新路径。若配套技能检测到SDK/技能版本不一致,重新运行或;这些是标准修复路径。
skillsworkflows-installworkflows-doctorbash
npx skills update --projectStep 7: Report Success
步骤7:报告成功结果
Tell the user:
- Zapier SDK CLI is installed and on PATH, confirmed via .
which zapier-sdk - Code Workflows experimental commands are available.
- The authenticated Zapier account email from .
zapier-sdk get-profile --json - Zapier Workflows EA access was confirmed with a read-only workflow listing.
- Five companion workflow skills are installed: ,
workflows/doctor,workflows/create,workflows/list, andworkflows/history.workflows/modify - This confirms SDK CLI install, login, Zapier Workflows EA access, and skill bootstrap. It does not yet prove that building, publishing, triggering, or running a full workflow works.
Next steps for the user:
- Configure app connections at https://zapier.com/app/assets/connections before attempting to build workflows.
- Reload your agent workspace so the new skills are picked up. This is required before the agent can reliably auto-discover the installed workflow skills.
- Ask your agent to create a workflow, for example: "Create a Zapier workflow that takes a manual input and sends a Slack message."
告知用户:
- Zapier SDK CLI已安装且在PATH中,通过确认。
which zapier-sdk - Code Workflows实验性命令可用。
- 已验证的Zapier账户邮箱来自。
zapier-sdk get-profile --json - 通过只读工作流列表确认拥有Zapier Workflows早期访问权限。
- 已安装五个工作流配套技能:、
workflows/doctor、workflows/create、workflows/list和workflows/history。workflows/modify - 以上确认了SDK CLI安装、登录、Zapier Workflows早期访问权限及技能引导完成,但尚未验证构建、发布、触发或运行完整工作流的功能。
用户后续步骤:
- 在尝试构建工作流前,前往https://zapier.com/app/assets/connections配置应用连接。
- 重新加载代理工作区,以便识别新安装的技能。这是代理能够可靠自动发现已安装工作流技能的必要步骤。
- 要求代理创建工作流,例如:"创建一个接收手动输入并发送Slack消息的Zapier工作流。"
Troubleshooting
故障排查
| Symptom | Likely cause | Fix |
|---|---|---|
| Old Node | |
| Global npm prefix is not user-writable | Use nvm or Homebrew Node; avoid |
| Old CLI or wrong package installed | Install |
| User has not authenticated the CLI | Run |
| The Zapier account is authenticated but does not have Zapier Workflows EA access | Stop before installing companion skills. Tell the user Zapier Workflows is currently only available to members of our closed beta, include the authenticated email, and ask them to rerun |
| No default browser configured, or remote/SSH session | Try |
| | Ask the user to run it manually in an actual terminal |
| Public skill source is unavailable, the skill has not been published yet, or network access failed | Confirm the |
| Skills do not auto-invoke after install | Agent workspace has not reloaded the skills directory | Reload workspace or restart your agent |
| 症状 | 可能原因 | 修复方法 |
|---|---|---|
| Node版本过旧 | |
| 全局npm前缀不可被用户写入 | 使用nvm或Homebrew安装Node;除非用户明确接受系统级变更,否则避免使用 |
| CLI版本过旧或安装了错误包 | 安装 |
| 用户未验证CLI | 在交互式终端中运行 |
| Zapier账户已验证但无Zapier Workflows早期访问权限 | 在安装配套技能前终止操作。告知用户Zapier Workflows目前仅对封闭测试成员开放,包含已验证邮箱,并要求用户加入白名单后重新运行 |
| 未配置默认浏览器,或处于远程/SSH会话 | 若已安装的CLI支持,尝试 |
| | 要求用户在真实终端中手动运行 |
| 公开技能源不可用、技能尚未发布或网络访问失败 | 确认 |
| 安装后技能无法自动调用 | 代理工作区未重新加载技能目录 | 重新加载工作区或重启代理 |