VS Code 中的流程

安装并配置 UiPath for Visual Studio 代码扩展程序，以便从本地工作区构建、调试和部署流程。

内容概览

UiPath for Visual Studio Code扩展程序可让您通过 VS Code 构建、调试和部署流程。它附带.flow文件的可视化编辑器，为您登录 UiPath，然后将您的工作打包并发布到 Orchestrator。

画布、节点、变量和调试的工作方式与 Studio Web 中相同。此页介绍 VS Code 的专属内容：安装扩展程序、登录以及从本地工作区打包。有关如何构建流程，请从您的第一个流程开始参阅本指南的其余部分。

开始之前

您需要满足以下条件：

• VS Code 1.110.0或更高版本。
• UiPath 帐户。
• Node.js 和 npm可在您的PATH上使用。首次登录时，扩展程序会通过 npm ( npm install -g @uipath/cli ) 安装 UiPath CLI ( uip )。
• 对 UiPath 环境的网络访问权限。

备注：

在 VS Code 中创建和编辑 Data Fabric 实体是一项预览版功能。仅在 VS Code 中可用 — Studio Web 可以打开包含实体项目的解决方案，但无法编辑实体本身。

扩展程序的运行位置也会影响其设置方式。以下说明适用于在远程环境而非本地计算机环境中工作。

备注：

在远程工作区（适用于 Linux 的 Windows 子系统 (WSL)、SSH、Codespace 或开发容器）中，扩展在远程主机上运行。UiPath CLI 必须安装在此处，而不是安装在本地计算机上。

安装扩展程序

1. 从 VS Code Marketplace 或 打开 VSX 注册表 安装 UiPath Maestro 。
2. 在系统提示时重新加载 VS Code。
3. 选择活动栏中的UiPath图标，以打开 UiPath 视图。

UiPath 视图分为三个部分：

• 连接会显示您的登录状态、环境和租户。
• 解决方案资源管理器列出工作区中的解决方案、项目和流程。
• 登录后， “资源”列出所选租户的文件夹和 Orchestrator 资源。

登录

该扩展程序使用捆绑的 UiPath 身份验证库以运行 OAuth/代码交换证明密钥 (PKCE) 浏览器流程，在流程内为您登录。扩展程序从不存储您的令牌。

1. 在“连接”部分中，选择“ 登录 ” 。
2. 如果尚未安装 CLI，请接受安装提示。扩展程序运行npm install -g @uipath/cli 。
3. 您的浏览器将打开以完成登录。身份验证库通过localhost端口8104接收回调。
4. 授权后，返回到 VS Code。此后，您的会话将自动刷新。

要退出登录，请在“连接”部分选择“退出登录” 。这将导致您从进程中注销并清除缓存的会话。

备注：

登录使用8104上的端口localhost进行 OAuth 回调。如果登录失败，则过时的流程可能占用端口。将其释放，然后重试。在 macOS 或 Linux 上，运行lsof -ti :8104 | xargs kill -9 。在 Windows 中，运行netstat -ano | findstr :8104以查找流程 ID，然后运行taskkill /F /PID <id> 。

选择您的环境和租户

登录后，选择您现在的工作地点。

1. 运行UiPath：选择“环境”以确认您的环境。默认为 Cloud。
2. 运行UiPath：选择“租户”以选取您的租户或组织。

然后，您可以在“资源”部分浏览所选租户的文件夹和资源。

结果： “资源”部分填充了所选租户的文件夹和 Orchestrator 资源。

创建或打开流程

• “运行流程：新建流程”( Ctrl/Cmd+Alt+N )，以创建新的.flow文件。
• 从资源管理器中打开现有的.flow文件，或运行“流程：打开流程” ( Ctrl/Cmd+Alt+O )。
• 打开解决方案后，在“解决方案资源管理器”标题栏中选择“添加流” ，以将流添加到活动项目中。

该文件将在可视化流编辑器中打开。构建、连接和配置节点与在 Studio Web 中完全相同。

您还可以在同一工作区中对 Data Fabric 实体进行建模。请参阅VS Code 中的实体。

Validate a flow

Flow validation errors and warnings appear in VS Code's Problems panel alongside your project's other diagnostics as you edit.

Select any entry to navigate directly to the offending node on the canvas, including nodes inside subflows. To validate on demand instead of waiting for the panel to update, run Flow: Validate Flow (Ctrl/Cmd+Shift+V).

打包并部署

您可以通过将工作区打包为 UiPath 解决方案并将其部署到 Orchestrator，从 VS Code 中进行发布。有关部署的作用，请参阅部署流程。

• UiPath：包从当前工作区构建.uipx解决方案。
• UiPath：“部署”可将打包的解决方案上传到 Orchestrator。
• UiPath：打包和部署同时运行这两个步骤。
• UiPath：切换部署目标会更改目标文件夹。

默认情况下，扩展程序会在成功部署后激活部署。要部署而不激活，请关闭uipath.autoActivateDeployment设置。

要从 UiPath CLI 运行相同的包，请运行“UiPath：生成.env 文件” 。这将写入与uip兼容的.env文件。

调试

在 VS Code 中调试通过您选择的 Cloud 租户进行路由。从编辑器运行流，并在实时调试视图中观看执行，该视图呈现随着运行的进度而更新的 Mersearch 执行流程图。有关如何读取运行并解决故障的信息，请参阅“有效调试” 。

命令和键盘快捷方式

运行“命令面板”( Ctrl/Cmd+Shift+P ) 中的任何命令。仅当.flow文件是活动编辑器时，流程编辑器快捷方式才适用。

流程编辑器

命令	默认按键绑定
流程：新流程	Ctrl/Cmd+Alt+N
流程：打开流程	Ctrl/Cmd+Alt+O
流程：保存流程	Ctrl/Cmd+S
流：将流另存为	Ctrl/Cmd+Shift+S
流程：撤消	Ctrl/Cmd+Z
流：重做	Ctrl+Y / Cmd+Shift+Z
流程：Zoom In	Ctrl/Cmd+=
流程：Zoom Out	Ctrl/Cmd+-
流程：重置 Zoom	Ctrl/Cmd+0
流程：适应屏幕	Ctrl/Cmd+Shift+F
流程：验证流程	Ctrl/Cmd+Shift+V
流程：导出流程	无

UiPath Platform

命令	描述
UiPath：登录	登录 UiPath。
UiPath：注销	退出登录并清除缓存的会话。
UiPath：选择环境	选择 UiPath 环境。
UiPath：选择租户	选择租户或组织。
UiPath：创建新项目	向解决方案添加项目。选择Data Fabric ，以创建实体项目。
UiPath：新建文件	向项目添加文件。选择“实体文件”以添加实体。
UiPath：添加实体文件	向现有实体项目添加另一个实体。在解决方案具备集成后可用。
UiPath：包	从工作区构建.uipx解决方案。
UiPath：部署	将打包的解决方案上传到 Orchestrator。
UiPath：打包和部署	在一步操作中打包和部署。
UiPath：切换部署目标	更改目标文件夹。
UiPath：生成.env文件	写入与 CLI 兼容的.env文件。
UiPath：刷新	刷新“连接”树。
UiPath：显示输出日志	打开 UiPath 输出通道。
UiPath：入门	打开“入门指南”演练。

有关完整的画布快捷方式，请参阅键盘快捷方式。

设置

在 VS Code 设置中配置扩展程序。

uipath.environment

登录时使用的 UiPath 环境。默认值为cloud 。如果现有 CLI 会话指向其他地方，则该会话优先。

uipath.autoActivateDeployment

成功部署后激活解决方案部署。默认值为true 。

uipath.cli.path

UiPath CLI 二进制文件的绝对路径 ( uip )。将该字段留空可在uip上查找PATH 。当 CLI 的安装位置不在PATH上时，请设置此项。

uipath.telemetry.enabled

发送匿名使用情况遥测数据。默认值为true 。该扩展程序还支持 VS Code 的全局telemetry.telemetryLevel 。关闭任一设置都会禁用遥测功能。

故障排除

登录失败

当 OAuth 回调端口繁忙或 CLI 丢失其会话时，登录将失败。

• 端口正在使用中。CLI 使用8104上的端口localhost进行回调。如果被过时的流程占用，请释放端口并重新登录。在 macOS 或 Linux 上，运行lsof -ti :8104 | xargs kill -9 。在 Windows 中，运行netstat -ano | findstr :8104 ，然后taskkill /F /PID <id> 。
• 会话已过时。运行“UiPath：注销” ，然后再次运行“UiPath：登录” ，以强制进行新登录。
• 阅读日志。运行UiPath：显示输出日志并检查UiPath输出通道中的登录错误。

找不到 CLI

扩展程序的 shell 输出为uip 。如果找不到二进制文件，登录和打包都会失败。

1. 通过在终端中运行uip --version来确认已安装 CLI。
2. 如果uip中没有PATH ，请将uipath.cli.path设置为二进制文件的绝对路径。
3. 如果尚未安装 CLI，请运行UiPath：登录并接受安装提示，或使用npm install -g @uipath/cli手动安装。这需要PATH上的 Node.js 和 npm。

远程工作区看不到 CLI

在 WSL、SSH、Codespaces 和开发容器工作区中，扩展程序在远程主机上运行，而不是在本地计算机上运行。必须在该主机上安装uip二进制文件。扩展程序看不到安装在本地 Windows 或 macOS 计算机上的 CLI。在远程工作区中安装 CLI，然后再次登录。

部署无法激活

默认情况下，扩展程序会在成功部署后激活部署。如果部署已上传但未激活，请确认uipath.autoActivateDeployment已打开。

相关页面

• 您的第一个流程
• VS Code 中的实体
• 部署流程
• 有效调试