跳到主要内容

从下载安装到发布第一个 workflow

按照下面的顺序,你可以在本地完成 workflow 开发,再把它发布到 Workflow Server,并在 Server Web 中管理运行、权限、日志和集成入口。

安装Desktop

打开 Desktop 下载,选择 macOS Apple Silicon、macOS Intel 或 Windows x64 安装包。安装后从 Applications、开始菜单或桌面快捷方式启动 Workflow Code。

创建或导入本地项目

在 Desktop 首页点击 New project 创建新 workflow,或点击 Import folder 导入已有 workflow 目录。项目会出现在本地项目列表中。

进入工作区编辑并运行

打开项目后,在 Files 中编辑源码,在 Run 中填写参数并执行 workflow。运行结果会直接显示在输出区,Trace 和 Logs 可从运行记录打开。

配置本地运行环境

需要密钥或第三方服务时,在 Desktop 工作区的 Env 中配置本地环境变量。本地 Env 只影响Desktop 运行,不会自动同步到服务器。

发布到 Workflow Server

登录账号后,在 Desktop 工作区点击 Publish。Desktop 会保存本地文件、上传项目包,并让服务器生成新版本。

在 Server Web 管理项目

打开 Server Web,进入项目详情页。你可以管理成员、运行队列、环境变量、KV、知识库、版本、Embed、Webhook 和执行日志。

按目标选择入口

常见操作路径

你想完成的事操作路径
新建第一个 workflowDesktop 首页 New project -> 打开工作区 -> Files 编辑 -> Run 运行。
把已有目录放进 DesktopDesktop 首页 Import folder -> 选择 workflow 目录 -> 打开项目。
本地调试参数和环境变量Desktop 工作区 Run 填参数,Env 配置本地变量,再执行运行。
发布可运行版本Desktop 工作区 Publish -> 保存文件 -> 上传项目包 -> server 发布新版本。
给服务器运行配置密钥Server Web 项目详情 -> 环境变量 -> 新增或更新变量。
查看失败原因Server Web 项目详情 -> 执行日志 -> 打开详细日志或回放。
开放页面给外部使用Server Web 项目详情 -> Embed -> 启用入口并复制链接。
接收外部系统事件Server Web 项目详情 -> Webhook -> 配置签名、映射和过滤规则。

后续阅读

  • 需要理解 workflow、payload、KV、文件、conversation 或 LLM provider 时,进入“参考手册”的核心概念。
  • 需要写代码时,进入“参考手册”的 Core API。
  • 需要在终端打包、上传、发布或远程运行时,进入“参考手册”的 CLI。
  • 需要对接服务端接口时,进入“服务端 API”。