Penstock

Guide / Start here

入门指南

从什么都没安装,到得到一个已检查、已部署的流程,大约只需十分钟。

Free

1. 获取 Penstock

Penstock 有多种形式,每种形式的功能都相同。选择您使用的那一种。

获取 Penstock

JetBrains

在 2023.1 及以后的任意 JetBrains IDE 中打开 Settings | Plugins | Marketplace,搜索 Penstock,然后点击 Install。也可以打开 Marketplace 页面。参见在 JetBrains IDE 中安装。

VS Code

在 VS Code 1.88 或更高版本中,从 Visual Studio Marketplace 安装扩展。参见在 VS Code 中安装。

Command line

可以安装一次,也可以不安装直接运行。需要 Node.js 22.22.2 或更高的 22 版本、24.15.0 或更高的 24 版本,或者 26 及以后版本。软件包发布在 npm 上。

npm install -g @kern0x1b/penstock-cli
npx @kern0x1b/penstock-cli

项目也可以通过 wrapper 脚本锁定版本。参见命令行。

在 VS Code 中,在终端里运行下面的命令,或者打开扩展页面并点击 Install:

code --install-extension penstock.penstock

2. 试用示例

想最快看到一切如何运转,就用示例:一个小型订单流程,包含 worker、一个决策、一个表单和测试用例。示例项目解释了其中的每个文件。把它写入一个空文件夹。

写入示例

JetBrains

打开一个空项目,然后打开 Penstock 工具窗口。其中提供 Camunda 8 order process 和 Camunda 7 order process。点击其中一个,并在 Start from an example 对话框中点击 Create 确认。随后会有一条通知告诉您示例所在的位置。

VS Code

在 VS Code 中打开一个空文件夹,然后打开活动栏中的 Penstock 视图。没有流程图的项目会提供示例。选择 Camunda 8 order process 或 Camunda 7 order process 即可创建。

Command line

在一个空文件夹中运行 penstock init --example camunda-8 或 --example camunda-7。它会写入示例文件和 penstockw wrapper。

penstock init --example camunda-8
终端中运行 penstock init --example camunda-8。它列出了写入的文件:penstock.yaml、README.md、.gitignore、pom.xml、application.yaml、order-process.bpmn、shipping-method.dmn、approve-order.form、两个 Java 文件、test-cases/order-process.json、一个 node-worker 文件夹以及 wrapper 文件
示例命令写入空文件夹的内容。

3. 查看、检查、部署

  1. 在编辑器中打开 src/main/resources/order-process.bpmn,流程图随即显示出来。
  2. 点击 Check。一张卡片会列出存在的问题。全新的示例没有任何问题。参见流程图检查。
  3. 点击 Deploy。会打开一个弹出框,第一次使用时它会询问引擎地址。填入地址并保存,然后再次部署。参见部署。

在您的工具中操作

JetBrains

从 Project 视图或 Penstock 工具窗口中打开文件。Check 和 Deploy 位于编辑器的工具栏上。

VS Code

从资源管理器中打开文件。Check 和 Deploy 位于编辑器的工具栏上。

Command line

命令行没有编辑器,所以请使用以下命令:

penstock check .
penstock deploy . --dry-run
penstock deploy .

从您自己的流程图开始

  1. 打开一个 .bpmn 文件。如果还没有,就新建一个名为 process.bpmn 的文件并打开它。空文件也可以。
  2. 如果流程图没有说明它使用哪种引擎,画布上方会出现一行提示:Which engine runs this diagram? 点击 Camunda 8、Operaton、CIB seven、Camunda 7、Flowable、Activiti 或 Classic BPMN。您的选择会写入项目根目录下的 penstock.yaml,如果该文件不存在则会自动创建。这个问题只问一次。
  3. 开始绘制。从左侧的元素面板拖入元素,或者点击一个元素,使用它旁边的小工具板。编辑流程图介绍了具体做法。
  4. 选中一个元素,在右侧的 Properties 标签页中填写它的属性。属性面板解释了各个分组。
  5. 点击 Check。在卡片或 Problems 标签页中修复列出的问题。

打开流程图

JetBrains

在 Project 视图或 Penstock 工具窗口中双击一个 .bpmn 文件。编辑器底部的 BPMN Editor 和 Text 标签页用于在图形和 XML 之间切换。参见IDE 中的编辑器。

VS Code

在资源管理器中双击一个 .bpmn 文件,它会在 Penstock 编辑器中打开。Penstock: Open as text 会在旁边打开 XML。参见VS Code 中各功能的位置。

Command line

不可用于 Command line. 命令行没有编辑器。请使用 penstock show 列出流程图内容,使用 penstock edit 修改流程图。

界面概览

编辑器中打开的一张流程图:工具栏在顶部,元素面板在画布旁边,侧边栏的 Properties 标签页在右侧,编辑器标签页在下方
编辑器中打开的一张流程图:工具栏在顶部,元素面板在画布旁边,选中元素的属性显示在右侧的侧边栏中,编辑器标签页在下方。

第一分钟

您的工具中的首次运行导览

JetBrains

编辑器第一次打开时,会用简短的几句话依次介绍六项内容:元素面板、属性面板、Check、工具窗口(它会指出工具窗口位于 IDE 侧边的工具条上)、Deploy 以及 More 菜单。导览只显示一次,是否已看过会记录在 ~/.penstock/preferences.json 中,与工具栏的设置放在一起。Show the tour again 位于 More 菜单的 Help 下。

VS Code

编辑器第一次打开时,会显示一个简短的导览。导览只显示一次。在命令面板中运行 Penstock: Show the tour again,或在 More 菜单中选择 Show the tour again,即可再次播放。

Command line

不可用于 Command line. 命令行没有编辑器,因此也没有导览。penstock doctor 会打印导览中会提到的那些设置。

最常用的操作一开始就固定在工具栏上:自动布局、Check、Simulate、Monitor、Scenarios、Coverage、Migrate to Camunda 8、Deploy 以及侧边栏开关。More 菜单和命令面板中每一行的图钉图标可以把操作放到工具栏上或从工具栏上移除。参见工具栏和 More 菜单。

哪些文件会在编辑器中打开

文件打开方式
.bpmn、.bpmn.xml、.bpmn20.xmlBPMN 编辑器
.dmnDMN 编辑器
属于 Camunda Form 的 .form表单编辑器

下一步

常见问题

工具栏上没有 Deploy。
Camunda 7、Camunda 8、Operaton 和 CIB seven 项目会显示 Deploy。Classic BPMN、Flowable 和 Activiti 项目没有这个按钮。请在 penstock.yaml 中更改引擎。
没有出现询问引擎的提示。
它只会对空流程图出现。如果流程图已经说明了它使用的引擎,或者项目的 penstock.yaml 中已有 engine,就不会询问。
示例没有写入。
示例只会写入空文件夹,因此绝不会覆盖您的文件。

试用与购买

每台电脑都先获得 30 天 Pro。试用无需登录,也无需填写银行卡。试用结束后,这台电脑会回到 Free 方案,编辑器、检查和部署仍可继续使用。

如需购买,请使用下面的链接之一。Polar 的结账页面会在浏览器中打开,付款完成后,Penstock 会察觉到并要求您输入发送到您邮箱的验证码。无需复制任何密钥。同一个许可证适用于这台电脑上的所有工具。

Free免费,并且每台新电脑都先获得 30 天 Pro。
Pro$9 / 月 或 $90 / 年
Team$29 / 月 或 $290 / 年 按席位计

如何激活、许可证涵盖哪些内容、Team 席位、流水线、离线使用、更换电脑以及取消订阅,都在购买与登录中说明。各方案包含的内容见方案与许可证。