studio

2022.4

false

Studio 用户指南

上次更新日期 2024年12月17日

批量更新命令行参数

“项目依赖项批量更新”命令行用户界面可用于批量更新属于多个自动化项目的 project.json 文件。该界面允许添加或删除依赖项、更改包版本和运行时规则，以及在发布流程或库前为其签名。

请注意，在使用“项目依赖项批量更新工具”时，您将隐式接受所更新的各个包版本的许可条款。

注意：自 Studio v2018.4.4 起，我们已为 Studio 企业版提供“项目依赖项批量更新”命令行用户界面。

UiPath.Studio.CommandLine.exe 位于安装文件夹中：

对于基于计算机的安装，默认路径为 C:\Program Files\UiPath\Studio\。
对于基于用户的安装，默认路径为 %localappdata%\Programs\UiPath\Studio。

根据 Studio 连接的来源控件系统（GIT、SVN 或 TFS），某些命令可能不可用。要查看特定于每个命令的参数，只需使用 --help。使用 --version 检查 UiPath.Studio.CommandLine.exe 的版本。

一个命令行中可以组合使用多个命令。此外，特定参数不需要在同一命令行中重复，例如将 r, --repository 用于 svn login 和 svn checkout 时。

注意：在将“项目依赖项批量更新”命令行用户界面与“TFS”搭配使用前，请确保您要更新的项目断开与当前用户的“TFS”的连接。

建议使用“项目依赖项批量更新工具”保存并关闭 Studio 中的项目，然后再进行更改。

用于更新本地文件的命令

list - 查找和显示存储在特定目录中的 project.json 文件的路径。也可以列出本地网络驱动器中的项目。以下参数应当与 list 命令搭配使用：

参数	描述
`-d, --directory`	存储有您要列出的文件的目录。将 `-u, --user` 和 `-p, --pass` 参数用于受密码保护的远程目录。

注意：如果未将 --directory 参数用于 list 命令，将显示当前工作目录中所有 project.json 文件的路径。

manage - 管理指定的项目。请注意，可以添加或删除多个依赖项和规则，只需使用空格分隔它们。以下参数应当与 manage 命令搭配使用：

参数	描述
`-a, --add-ref`	添加或更新依赖项及运行时规则到 `project.json` 文件。 `”dependencyname\|version\|runtimerule”` = 添加或更新依赖项版本和运行时规则。 `”dependencyname\|prereleaseversion\|runtimerule”` = 添加依赖项的预发行版本和指定运行时规则。
`r, --rem-ref`	从 `project.json` 文件删除指定的依赖项。 `"dependencyname"` - 从项目中删除依赖项，不论其版本为何。 `"dependencyname\|version"` - 删除此特定版本的依赖项，不论它是否为预发行版本。
`-p, --project-path`	`project.json` 文件的路径。

注意：运行时规则的语法是 lowest（代表“最低适用版本”）和 strict（“严格”版本）。如果这两个参数都未提及，则默认为应用“最低适用版本”。

例如，以下命令

manage --project-path "C:\Users\username\Documents\UiPath\BlankProcess\project.json" --add-ref "UiPath.Excel.Activities|2.6.2|lowest"

会将包版本更改为 2.6.2，并将运行时规则更改为“最低适用版本”。

publish - 发布项目及依赖项更改。以下参数应当与 publish 命令搭配使用：

参数	描述
`-p, --project-path`	要发布的 `project.json` 的路径。此为必选参数。
`-g, --target`	发布项目的位置： `Custom` - 自定义 URL 或本地文件夹。使用 `-f, --feed` 参数定义位置。 `Robot` - 机器人的默认发布位置（如果未连接到 Orchestrator）。不适用于发布库或模板。 `OrchestratorTenant` - Orchestrator 租户流程订阅源（适用于流程和测试用例）或 Orchestrator 库订阅源（适用于库和模板）。 `OrchestratorPersonalFolder` - Orchestrator 个人工作区订阅源。不适用于发布库、模板或测试用例。 `OrchestratorFolderHierarchy` - 如果是有单独包订阅源的一级文件夹，或者如果在 Studio 状态栏中，一个文件夹的子文件夹是从文件夹菜单中选择的，则为该文件夹层次结构的订阅源。不适用于发布库或模板。
`-f, --feed`	用于发布项目的自定义 URL。这也可以是自定义本地目录，与 Studio 的“发布选项”窗口中的路径类似。
`-a, --api-key`	用于发布项目的 API 密钥。此参数可用于自定义目标。
`-i, --icon`	用于包的自定义图标的路径。
`-n, --notes`	包含引入到项目中的更改的发行说明。
`-v, --new-version`	项目的新版本。
`-t, --timeout`	指定发布项目的超时值。默认超时为 30 秒。此设置仅适用于指示将包传输到 Orchestrator 的持续时间。
`--cer-path`	用于包签名的证书的本地路径。
`--cer-password`	证书的密码。
`--timestamper-url`	时间戳记程序的 URL。
`--incl-all-feeds`	非必填。

注意：目前，接受将 .pfx 和 .p12 证书扩展程序用于为项目签名。如需更多详细信息，请查阅为包签名页面。

基于以上示例，以下命令会将 UiPath.Excel.Activities 包更新为版本 2.6.2、将运行时规则更改为“最低适用版本”、添加发行说明和新版本，同时会将该项目发布到自定义位置：

manage --project-path "C:\Users\username\Documents\UiPath\BlankProcess\project.json"
                     --add-ref "UiPath.Excel.Activities|2.6.2|lowest" publish --project-path
                     "C:\Users\username\Documents\UiPath\BlankProcess\project.json" --target Custom --feed
                     "C:\Users\username\Desktop\myfeed" --notes "Changes were made to the Excel package"
                     --new-version "1.0.2"

。

工作流分析器命令

您可使用命令行参数，以基于一组规则分析文件或项目。

analyze - 分析整个项目。必须提供 project.json 文件的路径。

analyze-file - 分析单个文件。必须提供 .xaml 文件的路径。

参数	描述
`-p, --project-path`	分析一个文件时，应提供 `.xaml` 的路径。分析整个项目时，应指定 `project.json` 文件的路径。
`-c, --config-path`	`RuleConfig.json` 文件的路径。仅当规则配置文件未置于默认位置 (`%LocalAppData%\UiPath\Rules`) 时，才指定此路径。

阅读关于工作流分析器页面，详细了解如何使用命令行参数分析文件/项目及配置规则。

GIT 特定命令

git clone = 将存储库克隆到新目录。

注意：在运行 UiPath.Studio.CommandLine.exe git clone 之前，请确保存储库的凭据已存储在 Windows 凭据管理器中。否则，将发生认证错误。

以下参数应与 git clone 命令一起使用：

参数	描述
`r, --repository`	存储有您要修改的项目的存储库地址/URL。此为必选参数。
`-d, --directory`	工作目录。如果未指定，则使用当前环境目录。

git commit = 将更改记录到存储库。以下参数应当与 git commit 命令一起使用：

参数	描述
`-m, --message`	编写提交消息，以详细说明项目中引入的更改。提交消息为必填项。
`-p, --push`	将更改上传到远程存储库。
`-d, --directory`	工作目录。如果未指定，则使用当前环境目录。
`-f, --files`	您要编辑的文件的路径。路径应相对于工作目录并用分号分隔。

SVN 相关命令

svn login = 使用凭据来登录特定的 SVN 存储库。以下参数应当与 svn login 命令搭配使用：

参数	描述
`r, --repository`	存储有您要修改的项目的存储库地址/URL。此为必选参数。
`-p, --password`	SVN 存储库身份验证所需要的密码。
`-s, --password-stdin`	从 STDIN（标准输入）读取身份验证密码。您要在提示时输入所需存储库的密码。
`u, --user`	身份验证所需要的用户名。

svn checkout = 从 SVN 存储库签出项目。以下参数应当与 svn checkout 命令搭配使用：

参数	描述
`-d, --directory`	签出文件的目标文件夹。此为必选参数。
`-r, --repository`	存储有您要签出的文件的存储库地址。此为必选参数。

svn edit = 解锁一个或多个项目并使它们可供编辑。以下参数应当与 svn edit 命令搭配使用：

参数	描述
`-f, --files`	您要编辑的文件的路径。路径应相对于工作目录并用分号分隔。此为必选参数。
`-d, --directory`	含有您要编辑的文件的工作目录。如果未指定工作目录，则使用当前环境目录。

svn checkin = 签入对自动化项目进行的更改。以下参数应当与 svn checkin 命令搭配使用：

参数	描述
`-m, --message`	编写提交消息，以详细说明项目中引入的更改。提交消息为必填项。
`-d, --directory`	项目要签入到其中的工作目录。如果未指定工作目录，则使用当前环境目录。
`-f, --files`	您编辑的文件的路径。路径应相对于工作目录并用分号分隔。

TFS 相关命令

tfs login = 使用凭据来登录特定的 TFS 存储库。以下参数应当与 tfs login 命令搭配使用：

参数	描述
`-t, --type`	TFS 存储库的登录方式： `ntlm` = 通过本地 TFS 存储库中的 NT LAN 管理器进行身份验证。 `token` = 使用 TFS 存储库中启用的个人访问令牌进行身份验证。 `basic` = 安全 TFS 存储库中的基本身份验证。
`-p, --password`	SVN 存储库身份验证所需要的密码。
`-s, --password-stdin`	从 STDIN（标准输入）读取身份验证密码。您要在提示时输入所需存储库的密码。
`u, --user`	身份验证所需要的用户名。
`-c, --collection`	指代集合 URI。此为必选参数。

tfs checkout = 从 TFS 存储库签出项目。以下参数应当与 tfs checkout 命令搭配使用：

参数	描述
`-c, --collection`	指定集合 URI。
`-d, --directory`	签出文件的目标文件夹。此为必选参数。
`-r, --remotedir`	项目目录的路径，相对于集合根目录。以 `$/` 开头，其前面是集合 URI。

tfs edit - 解锁一个或多个项目并使它们可供编辑。以下参数应当与 tfs edit 命令搭配使用：

参数	描述
`-f, --files`	您要编辑的文件的路径。路径应相对于工作目录并用分号分隔。
`-d, --directory`	含有您要编辑的文件的工作目录。如果未指定工作目录，则使用当前环境目录。

tfs checkin - 签入对自动化项目进行的更改。以下参数应当与 tfs checkin 命令搭配使用：

参数	描述
`-m, --message`	编写提交消息，以详细说明项目中引入的更改。提交消息为必填项。
`-d, --directory`	项目要签入到其中的工作目录。如果未指定工作目录，则使用当前环境目录。
`-f, --files`	您编辑的文件的路径。路径应相对于工作目录并用分号分隔。

更新较旧的自动化项目

在利用命令行用户界面安装依赖项到使用 v2018.3 之前的 Studio 版本创建的项目中时，请考虑以下细节：

如果项目未曾发布过，因而没有安装依赖项，则迁移流程将介入并安装默认的包，具体如“管理依赖项”页面中的详细说明。
如果项目是使用 v2018.3 之前的 Studio 版本创建并发布的，则 UiPath.Core.Activities 包将迁移到 UiPath.System.Activities 和 UiPath.UIAutomation.Activities。