uipath-platform

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

UiPath Platform — uip CLI Assistant

UiPath平台 — uip CLI助手

Comprehensive guide for UiPath Cloud / Orchestrator / Studio Web / Integration Service, end-to-end via the

uip

CLI. For

uip solution

lifecycle load

uipath-solution

; for PDD/SDD design & task planning load

uipath-planner

本文档是通过

uip

CLI对UiPath Cloud、Orchestrator、Studio Web、Integration Service进行端到端操作的综合指南。若需进行

uip solution

生命周期管理，请加载

uipath-solution

；若需进行PDD/SDD设计与任务规划，请加载

uipath-planner

。

Route Diagnostic Intent Before Platform Work

平台操作前先明确诊断意图

Classify the requested outcome before running any command:

Causal outcome → hand off immediately. User wants an explanation, diagnosis, or root cause for undesirable existing behavior → invoke the
```
Skill
```
tool with uipath-troubleshoot (name exactly as it appears in your available-skills list) before running anything. No preliminary job/log/trace fetching — troubleshoot owns evidence collection. Prose telling the user to use troubleshoot is not a substitute for the
```
Skill
```
call.
Operational outcome → stay here. Inspect current state without a causal question, perform CRUD or lifecycle actions, validate an input before applying it, or execute an already-diagnosed platform fix.
Mixed request → troubleshoot first. Hand off the diagnosis; return here only for the platform mutation that applies the confirmed fix.
Sibling unavailable → degrade gracefully. State the handoff could not run; give the entity, scope, and time window needed to retry the investigation. Do not improvise a platform-only root cause.

在执行任何命令前，先对用户请求的结果进行分类：

因果性结果 → 立即转交。用户希望对不良现有行为进行解释、诊断或根因分析→在执行任何操作前，调用
```
Skill
```
工具并指定uipath-troubleshoot（名称需与可用技能列表中的完全一致）。无需预先获取作业/日志/追踪信息——排查工具负责证据收集。仅告知用户使用排查工具不能替代
```
Skill
```
调用。
操作性结果 → 继续使用本技能。仅检查当前状态（无因果疑问）、执行CRUD或生命周期操作、在应用前验证输入，或执行已诊断完成的平台修复。
混合请求 → 先进行排查。转交诊断任务；仅在应用已确认的修复方案时返回本技能。
关联技能不可用 → 优雅降级。说明无法转交任务；告知用户重试排查所需的实体、范围和时间窗口。请勿自行尝试仅通过平台操作进行根因分析。

Use the CLI. Don't roll your own REST.

使用CLI，不要自行编写REST请求

Always reach for
uip
CLI commands first. The CLI covers auth, Orchestrator (folders, processes, jobs, machines, users, roles, sessions, calendars, settings, audit logs, credential stores, feeds, attachments), resources (assets, queues, queue items, storage buckets, bucket files, libraries, webhooks, triggers), Integration Service (connectors, connections, activities, IS triggers), traces, and licensing end-to-end.

Hand-rolling HTTP calls — reading

~/.uipath/.auth

and POSTing to

/odata/...

/orchestrator_/...

— almost always misses something the CLI gets right: the

X-UIPATH-OrganizationUnitId

folder header, OData filter shape (

Key eq '...'

with escaped single quotes), pagination envelope, retry semantics, validation error shape, or

Result/Code/Data

output contract. Reach for raw REST only after you've searched
references/uip-commands.md
for your task and confirmed no
uip
command covers it. The CLI is the source of truth.

If you find yourself about to

curl

https://cloud.uipath.com/...

— stop. Search the command index first. Examples of what people often miss:

"upload a file to a storage bucket" →

uip or bucket-files upload

(NOT a

PUT /buckets/.../signedUrl

dance)

"create an asset" →
```
uip or assets create
```
(NOT a
```
POST /odata/Assets
```
)

"start a job for a process" →

uip or jobs start <process-key>

(NOT

POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

)

"configure an Integration Service connection" →
```
uip is connections create <connector-key>
```
(NOT a hand-rolled OAuth flow)
"attach a file to a Data Fabric record" →
```
uip df files upload <entity-id> <record-id> <field-name> --file <path>
```
(NOT
```
records insert
```
/
```
records update
```
with the file value — the platform silently strips FILE columns and returns Success, see
```
references/data-fabric/data-fabric.md
```
Rule 6)

优先使用
uip
CLI命令。CLI全面覆盖认证、Orchestrator（文件夹、流程、作业、机器、用户、角色、会话、日历、设置、审计日志、凭证存储、源、附件）、资源（资产、队列、队列项、存储桶、桶文件、库、Webhook、触发器）、Integration Service（连接器、连接、活动、IS触发器）、追踪和许可管理的端到端操作。

手动编写HTTP请求——读取

~/.uipath/.auth

并向

/odata/...

或

/orchestrator_/...

发送POST请求——几乎总会遗漏CLI已处理好的细节：

X-UIPATH-OrganizationUnitId

文件夹头、OData筛选格式（带转义单引号的

Key eq '...'

）、分页包、重试机制、验证错误格式，或

Result/Code/Data

输出约定。仅在搜索
references/uip-commands.md
确认无对应
uip
命令覆盖你的任务后，再使用原生REST请求。CLI是权威来源。

如果你正准备执行

curl

https://cloud.uipath.com/...

——请停下。先搜索命令索引。以下是人们常遗漏的示例：

"上传文件到存储桶" →
```
uip or bucket-files upload
```
（无需执行
```
PUT /buckets/.../signedUrl
```
这类复杂操作）
"创建资产" →
```
uip or assets create
```
（无需执行
```
POST /odata/Assets
```
）

"启动流程作业" →

uip or jobs start <process-key>

（无需执行

POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

）

"配置Integration Service连接" →
```
uip is connections create <connector-key>
```
（无需手动编写OAuth流程）
"为Data Fabric记录附加文件" →
```
uip df files upload <entity-id> <record-id> <field-name> --file <path>
```
（不要使用
```
records insert
```
/
```
records update
```
并传入文件值——平台会静默剥离FILE列并返回成功，详见
```
references/data-fabric/data-fabric.md
```
规则6）

When to Use This Skill

何时使用本技能

Load this skill BEFORE writing any code that talks to UiPath. Specific triggers:

Auth & tenant: login, logout, switch tenant, named login profiles via
```
--profile <name>
```
,
```
~/.uipath/.auth
```
, OAuth token, organization
Orchestrator core: folders (
```
list/get/create/edit/move/delete/runtimes
```
), processes/releases, jobs (
```
start/stop/logs/traces/healing-data
```
), packages (
```
upload/download/versions
```
), machines, users / roles / sessions (incl. DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication), licenses, calendars, settings, audit logs, credential stores, feeds, attachments
Resources (Orchestrator-scoped): assets (text/integer/bool/credential), queues + queue items, storage buckets + bucket files (
```
upload/download/get-download-url/get-upload-url
```
), libraries (
```
.nupkg
```
), webhooks (HMAC signing), triggers (time/queue/api)
Integration Service: connectors, connections (OAuth flow), activities, IS triggers, agent-workflow reference resolution
**Data Fabric **: UiPath's structured, typed data store. **⛔ STOP — before ANY
```
uip df
```
command, Read
```
references/data-fabric/data-fabric.md
```
.The reference carries Critical Rules (folder-scope prompt flow, irreversible-op gates, complex-field config), request-body schema, per-type operator matrix, and routes to topic files:
```
entity-schema.md
```
,
```
records-query.md
```
,
```
filter-platform-contract.md
```
,
```
choice-sets.md
```
,
```
file-attachments.md
```
,
```
bulk-import.md
```
. Surfaces:
- Entities — schemas with typed columns, per-type constraints (
```
lengthLimit
```
  ,
```
minValue
```
  /
```
maxValue
```
  ,
```
decimalPrecision
```
  ), choice-set / relationship / file fields,
```
addFields
```
  /
```
updateFields
```
  /
```
removeFields
```
  evolution.
- Records — insert / update / delete / list / get /
```
query
```
  with server-side filters, sorting, pagination, group-by, and aggregates (
```
COUNT
```
  ,
```
SUM
```
  ,
```
AVG
```
  ,
```
MIN
```
  ,
```
MAX
```
  ).
  - DF filter body uses
```
filterGroup.queryFilters[]
```
    — full shape in
    records-query.md
    .
- Files — binary attachments stored on
```
FILE
```
  -typed fields via
```
files upload / download / delete
```
  (record-level writes silently strip FILE values; the dedicated verbs are mandatory).
- Choice sets — shared enumerations consumed by
```
CHOICE_SET_SINGLE
```
  /
```
CHOICE_SET_MULTIPLE
```
  fields; values use immutable integer
```
NumberId
```
  s, not labels.
- Folder scoping — tenant-level OR folder-scoped via
```
--folder-key <GUID>
```
  on every write,
```
--include-folders
```
  on
```
entities list
```
  /
```
choice-sets list
```
  .
- CSV bulk import —
```
uip df records import <entity-id> --file <path.csv> --output json
```
  . Basic field types only; complex fields (CHOICE_SET, RELATIONSHIP, FILE, AUTO_NUMBER) require
```
records insert --file <json>
```
  .
For Query / Create / Update / Delete / GetById connector nodes inside a
.flow
, hand off to
```
uipath-maestro-flow
```
— that skill owns the in-flow node JSON,
```
bindings_v2.json
```
, and connection-resource layout.
LLM Gateway — BYO product configurations:
```
uip llm-configuration byo-connections
```
(
```
list / get / create / update / delete / list-product-configs
```
). Register tenant-owned OpenAI / Azure OpenAI / AWS Bedrock / Google Vertex / Anthropic / OpenAI-compatible keys against UiPath product features (agents, agenthub, jarvis, IXP, agent builder, ECS). Two input shapes: single-mapping (for
```
AnyModelWithOwnAdditions
```
features) and repeated
```
--mapping
```
(required for
```
AllModels
```
/
```
AnyModel
```
). Server-side validation is mandatory.
LLM Gateway — diagnose a failing BYO config: re-probe the underlying IS connection with
```
byo-connections get <id> --force-refresh
```
, force a fresh server-side probe with an idempotent
```
update
```
, audit the tenant with
```
list --include-connection-details
```
filtered on
```
connectionState != Enabled
```
, check catalog drift with
```
list-product-configs
```
, and cross-reference trace evidence with
```
uip traces spans get <trace-id>
```
. The gateway does not expose per-request invocation logs via CLI — diagnosis is current-state + trace evidence only. See
```
references/llmgateway/byo-connections.md
```
§ Diagnostics
. For tenant-wide AI Trust Layer policy that may be overriding routing, see uipath-governance.
AI Trust Layer — BYO guardrail (BYOG) configurations:
```
uip guardrails byo-configurations
```
(
```
list / list-validators / probe / create / update / delete
```
) — manage tenant-registered external guardrail validator providers (e.g. Azure AI Content Safety, Databricks AI Guardrails), each backed by an Integration Service connection.
```
ValidatorName
```
is tenant-unique and is the only value agents reference (
```
ByoValidator(<ValidatorName>)
```
— the connection resolves server-side). Before creating,
```
list
```
(the name must be free) and
```
uip is connections list
```
(for
```
--connection-id
```
);
```
create
```
always probes the connection/validator pair server-side and aborts if the probe fails, with no skip flag, and
```
update
```
re-probes whenever
```
--connection-id
```
changes.
```
probe
```
and
```
list-validators
```
test a pairing without saving anything;
```
update
```
merges supplied fields and can flip
```
--enabled
```
/
```
--disabled
```
;
```
delete
```
requires
```
--force
```
; no
```
get
```
verb. See
```
references/guardrails/byo-configurations.md
```
. For authoring a guardrail against one of these configurations (low-code or coded), see uipath-agents.
Traces:
```
uip traces spans get <trace-id>
```
(LLM/agentic execution observability)
Context grounding: knowledge indexes for semantic search / RAG —
```
uip context-grounding
```
(
```
list / create
```
from a bucket or connection
```
/ ingest / retrieve
```
to poll ingestion status
```
/ search / delete
```
). Agents and flows consume these indexes as tools. See
```
references/context-grounding/index-management.md
```
.
Platform licensing: tenant license allocations, user/group bundle assignments, consumables reporting (
```
uip platform tenants licenses
```
,
```
users licenses
```
,
```
groups rules
```
,
```
licenses consumables get
```
— the only consumables verb; summary/daily/folders are
```
--mode
```
values)

CLI tooling itself:

uip tools list/search/install

uip mcp serve

For

uip solution

lifecycle (init / pack / publish / deploy / activate / upload) and CI/CD pipelines that build and deploy UiPath solutions, load

uipath-solution

在编写任何与UiPath交互的代码前加载本技能。触发场景包括：

认证与租户：登录、登出、切换租户、通过
```
--profile <name>
```
使用命名登录配置文件、
```
~/.uipath/.auth
```
、OAuth令牌、组织管理
Orchestrator核心：文件夹（
```
list/get/create/edit/move/delete/runtimes
```
）、流程/版本、作业（
```
start/stop/logs/traces/healing-data
```
）、包（
```
upload/download/versions
```
）、机器、用户/角色/会话（含DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication）、许可、日历、设置、审计日志、凭证存储、源、附件
资源（Orchestrator范围）：资产（文本/整数/布尔/凭证）、队列+队列项、存储桶+桶文件（
```
upload/download/get-download-url/get-upload-url
```
）、库（
```
.nupkg
```
）、Webhook（HMAC签名）、触发器（时间/队列/API）
Integration Service：连接器、连接（OAuth流程）、活动、IS触发器、代理-工作流引用解析
Data Fabric：UiPath的结构化类型数据存储。⚠️ 注意——在执行任何
uip df
命令前，请阅读
references/data-fabric/data-fabric.md
。该文档包含关键规则（文件夹范围提示流程、不可逆操作限制、复杂字段配置）、请求体 schema、各类型操作符矩阵，以及主题文档链接：
```
entity-schema.md
```
、
```
records-query.md
```
、
```
filter-platform-contract.md
```
、
```
choice-sets.md
```
、
```
file-attachments.md
```
、
```
bulk-import.md
```
。涵盖内容：
- 实体——带类型列的 schema，各类型约束（
```
lengthLimit
```
  、
```
minValue
```
  /
```
maxValue
```
  、
```
decimalPrecision
```
  ）、选择集/关联/文件字段，以及
```
addFields
```
  /
```
updateFields
```
  /
```
removeFields
```
  演化操作。
- 记录——插入/更新/删除/列表/获取/
```
query
```
  （支持服务端筛选、排序、分页、分组和聚合函数
```
COUNT
```
  、
```
SUM
```
  、
```
AVG
```
  、
```
MIN
```
  、
```
MAX
```
  ）。
  - DF筛选体使用
```
filterGroup.queryFilters[]
```
    ——完整格式详见
    records-query.md
    。
- 文件——通过
```
files upload / download / delete
```
  操作将二进制附件存储在
```
FILE
```
  类型字段上（记录级写入会静默剥离FILE值；必须使用专用命令）。
- 选择集——供
```
CHOICE_SET_SINGLE
```
  /
```
CHOICE_SET_MULTIPLE
```
  字段使用的共享枚举；值使用不可变的整数
```
NumberId
```
  ，而非标签。
- 文件夹范围——租户级或通过在每次写入时添加
```
--folder-key <GUID>
```
  指定文件夹范围，
```
entities list
```
  /
```
choice-sets list
```
  时使用
```
--include-folders
```
  参数。
- CSV批量导入——
```
uip df records import <entity-id> --file <path.csv> --output json
```
  。仅支持基础字段类型；复杂字段（CHOICE_SET、RELATIONSHIP、FILE、AUTO_NUMBER）需使用
```
records insert --file <json>
```
  。
对于
```
.flow
```
内部的查询/创建/更新/删除/按ID获取连接器节点，请转交至
```
uipath-maestro-flow
```
——该技能负责处理流内节点JSON、
```
bindings_v2.json
```
和连接资源布局。
LLM网关——BYO产品配置：
```
uip llm-configuration byo-connections
```
（
```
list / get / create / update / delete / list-product-configs
```
）。将租户自有OpenAI/Azure OpenAI/AWS Bedrock/Google Vertex/Anthropic/兼容OpenAI的密钥注册到UiPath产品功能（agents、agenthub、jarvis、IXP、agent builder、ECS）。支持两种输入格式：单一映射（适用于
```
AnyModelWithOwnAdditions
```
功能）和重复
```
--mapping
```
（
```
AllModels
```
/
```
AnyModel
```
功能必填）。服务端验证是强制要求。
LLM网关——排查BYO配置故障：使用
```
byo-connections get <id> --force-refresh
```
重新探测底层IS连接，通过幂等
```
update
```
操作强制服务端重新探测，使用
```
list --include-connection-details
```
并筛选
```
connectionState != Enabled
```
审计租户，使用
```
list-product-configs
```
检查目录漂移，以及使用
```
uip traces spans get <trace-id>
```
交叉验证追踪证据。网关不通过CLI暴露每个请求的调用日志——只能通过当前状态+追踪证据进行诊断。详见
```
references/llmgateway/byo-connections.md
```
§ 诊断
。若需查看可能覆盖路由的租户级AI信任层策略，请参考uipath-governance。
AI信任层——BYO防护规则（BYOG）配置：
```
uip guardrails byo-configurations
```
（
```
list / list-validators / probe / create / update / delete
```
）——管理租户注册的外部防护规则验证器提供商（如Azure AI Content Safety、Databricks AI Guardrails），每个提供商由一个Integration Service连接提供支持。
```
ValidatorName
```
在租户内唯一，是代理引用的唯一值（
```
ByoValidator(<ValidatorName>)
```
——连接由服务端解析）。创建前，需执行
```
list
```
（确保名称可用）和
```
uip is connections list
```
（获取
```
--connection-id
```
）；
```
create
```
操作会强制服务端探测连接/验证器配对，若探测失败则中止，无跳过标志；当
```
--connection-id
```
变更时，
```
update
```
操作会重新探测；
```
probe
```
和
```
list-validators
```
操作可测试配对但不保存；
```
update
```
操作会合并提供的字段并可切换
```
--enabled
```
/
```
--disabled
```
；
```
delete
```
操作需使用
```
--force
```
；无
```
get
```
命令。详见
```
references/guardrails/byo-configurations.md
```
。若需基于这些配置编写防护规则（低代码或编码方式），请参考uipath-agents。
追踪：
```
uip traces spans get <trace-id>
```
（LLM/代理执行可观测性）
上下文grounding：用于语义搜索/RAG的知识索引——
```
uip context-grounding
```
（
```
list / create
```
从存储桶或连接创建/
```
ingest / retrieve
```
轮询摄入状态/
```
search / delete
```
）。代理和流将这些索引作为工具使用。详见
```
references/context-grounding/index-management.md
```
。
平台许可：租户许可分配、用户/组包分配、消耗报告（
```
uip platform tenants licenses
```
、
```
users licenses
```
、
```
groups rules
```
、
```
licenses consumables get
```
——唯一的消耗命令；汇总/每日/文件夹是
```
--mode
```
可选值）

CLI工具本身：

uip tools list/search/install

、

uip mcp serve

若需进行

uip solution

生命周期管理（init/pack/publish/deploy/activate/upload）以及构建和部署UiPath解决方案的CI/CD流水线，请加载

uipath-solution

。

Auth token location

认证令牌位置

The default login stores credentials at ~/.uipath/.auth
:

UIPATH_URL=https://cloud.uipath.com
UIPATH_ORGANIZATION_NAME=my_org
UIPATH_TENANT_NAME=my_tenant
UIPATH_ACCESS_TOKEN=eyJ...
UIPATH_ORGANIZATION_ID=...
UIPATH_TENANT_ID=...

Named profiles store credentials at ~/.uipath/profiles/<name>/.auth
. Use named profiles when the user asks to keep multiple UiPath logins on the same machine:

bash

uip login --profile dev --output json
uip login status --profile dev --output json
uip login which --profile dev --output json

Rules:

```
--profile <name>
```
is a global option. Pass it on every
```
uip
```
command that should use that login, for example
```
uip --profile dev or folders list --output json
```
.
```
default
```
means the built-in unprofiled login and maps back to
```
~/.uipath/.auth
```
.
Profile names may contain only letters, numbers,
```
.
```
,
```
_
```
, and
```
-
```
. Never use paths like
```
../prod
```
.
```
--profile
```
and auth-command
```
--file <folder>
```
are mutually exclusive. Use one or the other.
A missing named profile does not fall back to
```
~/.uipath/.auth
```
or Robot credentials. Tell the user to run
```
uip login --profile <name>
```
.

These tokens can be reused for direct Orchestrator REST API calls when CLI commands don't cover a use case. If a named profile is active, read the path from

uip login which --profile <name> --output json

rather than assuming

~/.uipath/.auth

默认登录的凭据存储在**

~/.uipath/.auth

**：

UIPATH_URL=https://cloud.uipath.com
UIPATH_ORGANIZATION_NAME=my_org
UIPATH_TENANT_NAME=my_tenant
UIPATH_ACCESS_TOKEN=eyJ...
UIPATH_ORGANIZATION_ID=...
UIPATH_TENANT_ID=...

命名配置文件的凭据存储在**

~/.uipath/profiles/<name>/.auth

**。当用户需要在同一台机器上保留多个UiPath登录时，使用命名配置文件：

bash

uip login --profile dev --output json
uip login status --profile dev --output json
uip login which --profile dev --output json

规则：

```
--profile <name>
```
是全局选项。所有需要使用该登录的
```
uip
```
命令都需传入该参数，例如
```
uip --profile dev or folders list --output json
```
。
```
default
```
表示内置的未配置文件登录，对应
```
~/.uipath/.auth
```
。
配置文件名称仅可包含字母、数字、
```
.
```
、
```
_
```
和
```
-
```
。请勿使用
```
../prod
```
这类路径。
```
--profile
```
和认证命令的
```
--file <folder>
```
参数互斥。只能使用其中一个。
若指定的命名配置文件不存在，不会回退到
```
~/.uipath/.auth
```
或Robot凭据。请告知用户执行
```
uip login --profile <name>
```
。

当CLI命令无法覆盖某个用例时，这些令牌可用于直接调用Orchestrator REST API。若使用命名配置文件，请通过

uip login which --profile <name> --output json

读取路径，而非默认假设

~/.uipath/.auth

。

Quick Start

快速开始

Step 1 — Authenticate

步骤1 — 认证

Before interacting with Orchestrator, solutions, or Integration Service, the user must be logged in.

Always check first — most sessions are already authenticated:

bash

uip login status --output json

If it reports

Logged in

, skip the rest of this step. There is no

--check

flag —

status

is the verification subcommand.

If the user names a profile, check that profile explicitly:

bash

uip login status --profile dev --output json

Interactive login (browser OAuth2):

uip login

opens a browser window on the user's machine and blocks until they complete it. In a non-interactive or automated session, do NOT run it yourself — tell the user to run it and wait.

bash

uip login --output json

For a named interactive login:

bash

uip login --profile dev --output json

For a custom authority (e.g., alpha.uipath.com):

bash

uip login --authority "https://alpha.uipath.com/identity_" --it --output json

For non-interactive (CI/CD) scenarios, use client credentials:

bash

uip login --client-id "<ID>" --client-secret "<SECRET>" --tenant "<TENANT>" --output json

在与Orchestrator、解决方案或Integration Service交互前，用户必须已登录。

先检查登录状态——大多数会话已处于认证状态：

bash

uip login status --output json

若返回

Logged in

，则跳过本步骤剩余内容。没有

--check

标志——

status

是验证子命令。

若用户指定了配置文件，请检查该配置文件的状态：

bash

uip login status --profile dev --output json

交互式登录（浏览器OAuth2）：

uip login

会在用户机器上打开浏览器窗口，直到用户完成登录才会结束。在非交互式或自动化会话中，请勿自行执行该命令——请告知用户执行并等待。

bash

uip login --output json

命名配置文件的交互式登录：

bash

uip login --profile dev --output json

自定义授权服务器（如alpha.uipath.com）：

bash

uip login --authority "https://alpha.uipath.com/identity_" --it --output json

非交互式（CI/CD）场景，使用客户端凭据：

bash

uip login --client-id "<ID>" --client-secret "<SECRET>" --tenant "<TENANT>" --output json

Step 2 — Select a Tenant

步骤2 — 选择租户

List available tenants and set the active one:

bash

uip login tenant list --output json
uip login tenant set "<TENANT_NAME>" --output json

列出可用租户并设置活动租户：

bash

uip login tenant list --output json
uip login tenant set "<TENANT_NAME>" --output json

Step 3 — Explore Orchestrator

步骤3 — 探索Orchestrator

List folders to orient yourself:

bash

uip or folders list --output json

列出文件夹以熟悉环境：

bash

uip or folders list --output json

Step 4 — Work with Orchestrator Resources

步骤4 — 操作Orchestrator资源

Choose the appropriate operation from the Task Navigation table below. For

uip solution

ops, load

uipath-solution

从下方任务导航表中选择合适的操作。若需

uip solution

操作，请加载

uipath-solution

。

Task Navigation

任务导航

I need to...	Read these
Authenticate / manage tenants	references/uip-commands.md
Set up folders, users, machines	references/orchestrator/setup-environment.md
Run and monitor jobs	references/orchestrator/run-jobs.md
Manage sessions and runtimes	references/orchestrator/manage-sessions.md
Tenant settings, calendars, audit logs	references/orchestrator/tenant-admin.md
Understand Orchestrator concepts	references/orchestrator/orchestrator.md
Manage assets	references/orchestrator/manage-assets.md
Work with queues and queue items	references/orchestrator/process-queues.md
Work with storage buckets and files	references/orchestrator/work-with-storage.md
Set up triggers and webhooks	references/orchestrator/triggers-and-webhooks.md
Develop / pack / publish / deploy / activate solutions; set up CI/CD	/uipath:uipath-solution
Debug LLM/agent traces (spans)	references/traces/traces.md
Annotate traces with feedback	references/traces/feedback.md
Use Integration Service	references/integration-service/integration-service.md
Use Data Fabric — entities, records, files, choice sets	references/data-fabric/data-fabric.md
Build an entity schema / add fields / complex field types	references/data-fabric/entity-schema.md
Query records — filters, pagination, aggregates, choice/relationship semantics	references/data-fabric/records-query.md
Filter operator support matrix per field type	references/data-fabric/filter-platform-contract.md
Manage choice sets and choice-set values	references/data-fabric/choice-sets.md
Upload / download / delete file attachments on records	references/data-fabric/file-attachments.md
Bulk import records from CSV	references/data-fabric/bulk-import.md
Configure BYO LLM keys (OpenAI / Azure OpenAI / Bedrock / Vertex / Anthropic)	references/llmgateway/byo-connections.md
Diagnose / audit / re-probe a BYO LLM configuration	references/llmgateway/byo-connections.md#diagnostics
Manage BYO guardrail (BYOG) configurations (list/create/update/delete)	references/guardrails/byo-configurations.md
Test whether a connection can serve a BYOG validator (probe / list-validators)	references/guardrails/byo-configurations.md#validation-mandatory-before-save
Diagnose a BYO guardrail (dead connection, disabled config)	references/guardrails/byo-configurations.md#diagnostics
Allocate licenses to tenants	references/licensing/tenant-allocations.md
Assign user/group license bundles	references/licensing/user-licenses-allocations.md
Report on license consumption	references/licensing/consumables-report.md
Understand licensing concepts	references/licensing/licensing.md
Full CLI command reference	references/uip-commands.md
Build/run/validate coded workflows	/uipath:uipath-rpa

我需要...	阅读以下文档
认证/管理租户	references/uip-commands.md
设置文件夹、用户、机器	references/orchestrator/setup-environment.md
运行和监控作业	references/orchestrator/run-jobs.md
管理会话和运行时	references/orchestrator/manage-sessions.md
租户设置、日历、审计日志	references/orchestrator/tenant-admin.md
理解Orchestrator概念	references/orchestrator/orchestrator.md
管理资产	references/orchestrator/manage-assets.md
处理队列和队列项	references/orchestrator/process-queues.md
处理存储桶和文件	references/orchestrator/work-with-storage.md
设置触发器和Webhook	references/orchestrator/triggers-and-webhooks.md
开发/打包/发布/部署/激活解决方案；设置CI/CD	/uipath:uipath-solution
调试LLM/代理追踪（跨度）	references/traces/traces.md
为追踪添加反馈注释	references/traces/feedback.md
使用Integration Service	references/integration-service/integration-service.md
使用Data Fabric——实体、记录、文件、选择集	references/data-fabric/data-fabric.md
构建实体schema/添加字段/复杂字段类型	references/data-fabric/entity-schema.md
查询记录——筛选、分页、聚合、选择/关联语义	references/data-fabric/records-query.md
各字段类型支持的筛选操作符矩阵	references/data-fabric/filter-platform-contract.md
管理选择集和选择集值	references/data-fabric/choice-sets.md
上传/下载/删除记录上的文件附件	references/data-fabric/file-attachments.md
从CSV批量导入记录	references/data-fabric/bulk-import.md
配置BYO LLM密钥（OpenAI/Azure OpenAI/Bedrock/Vertex/Anthropic）	references/llmgateway/byo-connections.md
诊断/审计/重新探测BYO LLM配置	references/llmgateway/byo-connections.md#diagnostics
管理BYO防护规则（BYOG）配置（列表/创建/更新/删除）	references/guardrails/byo-configurations.md
测试连接是否可支持BYOG验证器（探测/列出验证器）	references/guardrails/byo-configurations.md#validation-mandatory-before-save
诊断BYO防护规则故障（连接失效、配置禁用）	references/guardrails/byo-configurations.md#diagnostics
为租户分配许可	references/licensing/tenant-allocations.md
为用户/组分配许可包	references/licensing/user-licenses-allocations.md
报告许可消耗情况	references/licensing/consumables-report.md
理解许可概念	references/licensing/licensing.md
完整CLI命令参考	references/uip-commands.md
构建/运行/验证编码工作流	/uipath:uipath-rpa

Resolving UiPath Studio

解析UiPath Studio

Some operations (creating projects, validating, running workflows, packing) require UiPath Studio. When Studio is needed:

Check for a running instance first:
bash
```
rpa-tool list-instances --output json
```
If no instance is running, try the standard install location:
bash
```
rpa-tool start-studio --output json
```
If that fails (version too old, not found, etc.) — ASK THE USER where their Studio build is located. Do NOT search the entire filesystem. Common locations include:
- ```
C:\Program Files\UiPath\Studio
```
- A dev build directory (e.g.,
```
dev4/Studio/Output/bin/Debug
```
  )
- A custom install path

Once you have the path, pass it explicitly:

bash

rpa-tool start-studio --studio-dir "<STUDIO_DIR>" --output json

Never spend time searching for Studio automatically. If the default doesn't work, ask immediately — the user knows where their build is.

某些操作（创建项目、验证、运行工作流、打包）需要UiPath Studio。当需要Studio时：

先检查是否有运行中的实例：
bash
```
rpa-tool list-instances --output json
```
若没有运行中的实例，尝试标准安装路径：
bash
```
rpa-tool start-studio --output json
```
若失败（版本过旧、未找到等）——询问用户Studio的安装位置。请勿搜索整个文件系统。常见位置包括：
- ```
C:\Program Files\UiPath\Studio
```
- 开发构建目录（如
```
dev4/Studio/Output/bin/Debug
```
  ）
- 自定义安装路径

获取路径后，显式传入：

bash

rpa-tool start-studio --studio-dir "<STUDIO_DIR>" --output json

请勿自动搜索Studio。若默认路径无效，请立即询问用户——用户知道自己的构建位置。

Key Concepts

核心概念

UiPath Platform Hierarchy

UiPath平台层级

Organization
  └── Tenant(s)
        └── Folder(s)              ← Orchestrator folders (logical containers)
              ├── Processes         ← Published automation packages
              ├── Assets            ← Key-value configuration (Text, Bool, Integer, Credential, Secret)
              ├── Queues            ← Work item queues for distributed processing
              ├── Jobs              ← Running/completed process executions
              ├── Triggers          ← Event-based or queue-based job triggers
              ├── Schedules         ← Time-based job scheduling (cron)
              ├── Storage Buckets   ← File storage for automation data
              ├── Machines          ← Robot execution environments
              └── Robots            ← Attended/Unattended execution agents

Organization
  └── Tenant(s)
        └── Folder(s)              ← Orchestrator文件夹（逻辑容器）
              ├── Processes         ← 已发布的自动化包
              ├── Assets            ← 键值配置（文本、布尔、整数、凭证、机密）
              ├── Queues            ← 用于分布式处理的工作项队列
              ├── Jobs              ← 运行中/已完成的流程执行
              ├── Triggers          ← 基于事件或队列的作业触发器
              ├── Schedules         ← 基于时间的作业调度（cron）
              ├── Storage Buckets   ← 自动化数据文件存储
              ├── Machines          ← Robot执行环境
              └── Robots            ← 有人值守/无人值守执行代理

Robot Types

Robot类型

Type	Description	Use Case
Attended	Runs alongside a human user, triggered via UiPath Assistant	Front-office tasks, user-assisted automation
Unattended	Runs autonomously in virtual environments, managed by Orchestrator	Back-office tasks, scheduled processing, 24/7 operations

类型	描述	使用场景
有人值守（Attended）	与人类用户并行运行，通过UiPath Assistant触发	前台任务、用户辅助自动化
无人值守（Unattended）	在虚拟环境中自主运行，由Orchestrator管理	后台任务、调度处理、7×24小时运行

Folder Types

文件夹类型

Type	Description
Standard	Default folder for organizing automations
Personal	User-specific workspace
Virtual	Logical grouping without physical separation
Solution	Folder created by solution deployment
DebugSolution	Debug variant of a solution folder

类型	描述
标准（Standard）	组织自动化的默认文件夹
个人（Personal）	用户专属工作区
虚拟（Virtual）	无物理隔离的逻辑分组
解决方案（Solution）	部署解决方案时创建的文件夹
调试解决方案（DebugSolution）	解决方案文件夹的调试变体

Asset Types

资产类型

Type	Description
Text	Plain text value
Bool	Boolean (true/false)
Integer	Numeric integer value
Credential	Username + password pair
Secret	Encrypted secret value
DBConnectionString	Database connection string
HttpConnectionString	HTTP connection string
WindowsCredential	Windows credential pair

类型	描述
文本（Text）	纯文本值
布尔（Bool）	布尔值（true/false）
整数（Integer）	数值整数
凭证（Credential）	用户名+密码对
机密（Secret）	加密机密值
DBConnectionString	数据库连接字符串
HttpConnectionString	HTTP连接字符串
WindowsCredential	Windows凭证对

CLI Overview

CLI概述

The UiPath CLI (

uip

) is a unified command-line tool for interacting with the UiPath platform:

Command Group	Prefix	Description	Status
Authentication	`login` , `logout`	OAuth2, client credentials, PAT, tenant management	Available
Orchestrator	`or`	Folders, jobs, processes, releases	Available
Resource	`resource`	Assets, queues, queue items, storage buckets, bucket files	Available
Integration Service	`is`	Connectors, connections, activities, resources	Available
Data Fabric	`df`	Entities, records, files, choice sets ( `@uipath/data-fabric-tool` )	Available
Tools	`tools`	CLI tool extension management	Available
MCP	`mcp`	Model Context Protocol server	Available
Coded Agents	`codedagent`	Python agent lifecycle (setup, exec)	Available
RPA	`rpa`	RPA workflow management (create, compile, validate, execute)	Available

UiPath CLI（

uip

）是用于与UiPath平台交互的统一命令行工具：

命令组	前缀	描述	状态
认证	`login` , `logout`	OAuth2、客户端凭据、PAT、租户管理	可用
Orchestrator	`or`	文件夹、作业、流程、版本	可用
资源	`resource`	资产、队列、队列项、存储桶、桶文件	可用
Integration Service	`is`	连接器、连接、活动、资源	可用
Data Fabric	`df`	实体、记录、文件、选择集（ `@uipath/data-fabric-tool` ）	可用
工具	`tools`	CLI工具扩展管理	可用
MCP	`mcp`	模型上下文协议服务器	可用
编码代理	`codedagent`	Python代理生命周期（设置、执行）	可用
RPA	`rpa`	RPA工作流管理（创建、编译、验证、执行）	可用

Global Options

全局选项

Every

uip

command accepts:

Option	Description	Default
`--output <format>`	Output format: `table` , `json` , `yaml` , `plain`	`table` (interactive), `json` (non-interactive)
`--output-filter <expression>`	JMESPath expression to filter JSON output	--
`--profile <name>`	Use a named auth profile from `~/.uipath/profiles/<name>/.auth`	built-in default login
`--verbose`	Enable verbose/debug logging	Off
`--help` / `-h`	Display help for the command	--
`--version` / `-v`	Display CLI version	--

Always use
--output json
when calling
uip
commands programmatically. JSON is compact and machine-readable.
To narrow
list
results, use the noun's own filter flag (
--state Faulted
,
--type Text
,
--status New
,
--name
,
--process-name
,
--search
). The backend filters before sending; pagination stays correct. Per-noun flags: references/uip-commands.md. Never list-everything-then-filter-mentally.
Use
--output-filter
(JMESPath) for output reshaping or for fields with no server-side flag — e.g.,
--output-filter "Data[].{id: id, name: name}"
, or filtering by a derived/computed value. Don't reach for it when the server already has a filter for that attribute.

每个

uip

命令都支持以下选项：

选项	描述	默认值
`--output <format>`	输出格式： `table` 、 `json` 、 `yaml` 、 `plain`	交互式为 `table` ，非交互式为 `json`
`--output-filter <expression>`	用于筛选JSON输出的JMESPath表达式	——
`--profile <name>`	使用 `~/.uipath/profiles/<name>/.auth` 中的命名认证配置文件	内置默认登录
`--verbose`	启用详细/调试日志	关闭
`--help` / `-h`	显示命令帮助	——
`--version` / `-v`	显示CLI版本	——

以编程方式调用
uip
命令时，请始终使用
--output json
。JSON格式紧凑且易于机器读取。
如需缩小
list
结果范围，请使用对应名词自身的筛选标志（如
--state Faulted
、
--type Text
、
--status New
、
--name
、
--process-name
、
--search
）。后端会先筛选再返回结果；分页保持正确。各名词的标志详见
references/uip-commands.md
。请勿先列出所有结果再手动筛选。
使用
--output-filter
（JMESPath）进行输出重塑，或处理无服务端筛选标志的字段——例如
--output-filter "Data[].{id: id, name: name}"
，或按派生/计算值筛选。当服务端已有对应属性的筛选器时，请勿使用该选项。

Deployment Notes

部署注意事项

Starting jobs requires runtimes. If you get error 2818 "no runtimes configured", the target folder needs machine templates with Unattended/Development runtimes assigned.
For
uip solution
pack / publish / deploy / activate flows, load
uipath-solution
. This skill owns the auth and Orchestrator surface those flows depend on; the solution skill owns the lifecycle commands.
Fallback: direct REST API. When CLI tools don't support an operation, use the Orchestrator REST API with the access token from
```
~/.uipath/.auth
```
. See references/orchestrator/orchestrator.md - REST API.

启动作业需要运行时。若收到错误2818“未配置运行时”，则目标文件夹需要分配了无人值守/开发运行时的机器模板。
若需进行
uip solution
打包/发布/部署/激活流程，请加载
uipath-solution
。本技能拥有这些流程依赖的认证和Orchestrator操作面；解决方案技能拥有生命周期命令。
回退方案：直接调用REST API。当CLI工具不支持某个操作时，使用
```
~/.uipath/.auth
```
中的访问令牌调用Orchestrator REST API。详见references/orchestrator/orchestrator.md - REST API。

References

参考文档

CLI Command Reference — Every
```
uip
```
command with workflow links
Orchestrator — Concepts, folders, jobs, processes, machines, users
Resources — Assets, queues, buckets, triggers, libraries, webhooks

Solutions — Solution lifecycle (

uip solution init/pack/publish/deploy/activate

)

Planner — PDD/SDD design + multi-skill task planning (Process → Solution Design Document → task list)
Traces — Spans — LLM execution trace observability
Traces — Feedback — Annotate traces with sentiment and comments
Integration Service — Connectors, connections, activities, resources
Data Fabric — Entity schemas, records CRUD, query filters and aggregates, choice sets, file attachments, CSV bulk import, folder scoping
LLM Gateway — BYO Connections — Register tenant-owned LLM keys against UiPath products
Guardrails — BYOG Configurations — Manage tenant-registered bring-your-own guardrail (BYOG) configurations and diagnose their underlying Integration Service connections
Licensing — Tenant allocations, user/group bundles, consumables reporting
Coded Workflows — Building coded automation projects

Trouble? If something didn't work as expected, use
/uipath-feedback
to send a report.

CLI命令参考 —— 所有
```
uip
```
命令及工作流链接
Orchestrator —— 概念、文件夹、作业、流程、机器、用户
资源 —— 资产、队列、存储桶、触发器、库、Webhook
解决方案 —— 解决方案生命周期（
```
uip solution init/pack/publish/deploy/activate
```
）
规划工具 —— PDD/SDD设计+多技能任务规划（流程→解决方案设计文档→任务列表）
追踪——跨度 —— LLM执行追踪可观测性
追踪——反馈 —— 为追踪添加情感和注释
Integration Service —— 连接器、连接、活动、资源
Data Fabric —— 实体schema、记录CRUD、查询筛选和聚合、选择集、文件附件、CSV批量导入、文件夹范围
LLM网关——BYO连接 —— 将租户自有LLM密钥注册到UiPath产品
防护规则——BYOG配置 —— 管理租户注册的自有防护规则（BYOG）配置并诊断其底层Integration Service连接
许可 —— 租户分配、用户/组包、消耗报告
编码工作流 —— 构建编码自动化项目

遇到问题？ 如果操作未按预期执行，请使用
/uipath-feedback
提交报告。