第一个命令（快速入门）

本快速入门将介绍五个命令，这些命令将带您从全新安装转到在 Orchestrator 中运行作业。请等待五分钟。

在开始之前

• 安装 UiPath CLI。请参阅安装 UiPath CLI 。
• 拥有可访问至少一个租户的 UiPath Automation Cloud 或 Automation Suite 帐户。
• 了解 Orchestrator 中包含至少一个流程的文件夹的名称（或路径）。默认文件夹Shared适用于大多数试用版。

打开终端。均在此处输入以下所有命令。

步骤 1. 登录

启动交互式登录：

uip login

uip将打开您的默认浏览器，提示您登录到 UiPath，并在您进行身份验证后要求您选择租户。当浏览器选项卡报告成功时，返回到终端 — 会话处于活动状态。会话将保留在~/.uipath/中（如果当前文件夹或上级文件夹中存在项目的.uipath/文件夹）。

提示：

如果您已知租户并希望跳过选取器，请运行uip login --tenant DefaultTenant 。如果您在 CI 环境中，请参阅身份验证以了解非交互式流。

步骤 2. 确认会话

uip login status --output table

预期输出：

Status         Organization   Tenant          Expiration Date
Logged in      my-org         DefaultTenant   2026-04-24T18:42:00Z

备注：

默认情况下，每个uip命令都发出JSON 。对于便于读取的视图，传递--output table 。请参阅全局选项，以了解四种输出格式（ table 、 json 、 yaml和plain ）和 JMESPath --output-filter标志。

如果该命令报告Not logged in ，请重新运行uip login 。

步骤 3. 列出文件夹

第一个实际查询将访问 Orchestrator：

uip or folders list

这将返回租户中的前 50 个文件夹。输出包括每个文件夹的Key (GUID)、 Name 、 Path和Type 。

要进行筛选或更深入地查看，请传递--all以解锁筛选器：

uip or folders list --all --name Shared
uip or folders list --all --top-level

备注：

需要--all才能使筛选器标志（ --name 、 --path 、 --type 、 --top-level 、 --order-by ）生效。这是一个特意的安全网 — 如果大型租户的筛选器中存在拼写错误，大型租户会静默返回未筛选的第一页。

步骤 4. 查找要运行的流程

在步骤 3 中选择一个文件夹（此处以Shared为例）并列出其流程：

uip or processes list --folder-path Shared

输出将显示每个流程的Key (GUID)、 Name 、 Version和Type 。复制要运行的流程的Key 。在下一步中将<process-key>替换为该 GUID。

步骤 5. 开始作业

uip or jobs start <process-key>

uip在 Orchestrator 接受请求后立即返回。响应显示新作业的Key 、 State （首先通常为Pending ）和已解决的ProcessName 。

要在作业完成之前阻止并查看其输出，请添加--wait-for-completion ：

uip or jobs start <process-key> --wait-for-completion --timeout 600

使用--wait-for-completion时，该命令每五秒轮询一次（默认情况下），并在作业达到最终状态（ Successful 、 Faulted 、 Stopped ）时退出。Faulted上的退出代码不为零。--timeout以秒为单位，默认为 300。

使用--input-arguments （JSON 字符串）或--input-file （JSON 文件的路径）传递输入参数：

uip or jobs start <process-key> \
  --input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'

您刚才执行的操作

您可使用五个命令对两个 Orchestrator 资源进行身份验证、查询并启动作业。每个uip命令都遵循相同的形状（ uip <tool> <resource> <verb>表示具有多个资源的工具， uip <tool> <verb>表示单个工作流工具），并且每个命令都支持用于输出格式、筛选和日志记录的相同全局标志。请参阅全局选项。

后续步骤

• 您的第一个管道— 在本地打包解决方案，将其发布到您的租户，然后部署到 Orchestrator。
• 身份验证— 交互式登录详情、CI 的外部应用程序客户端凭据以及容器的环境变量流。
• 输出格式— 在table 、 json 、 yaml和plain之间切换，并将 JMESPath 筛选与--output-filter一起使用。
• Orchestrator 命令参考— 每个命令，每个标志。
• 将 UiPath CLI 与 Coding Agents 结合使用— 让 Claude Code、Cursor、GitHub Copilot 和其他智能体使用uip构建 UiPath 自动化。