UiPath CLI 用户指南
uip codedagent是连接基于 Python 的UiPath 编码智能体工作流的精简网桥。它会检测合适的 Python 解释器,确认已安装uipath Python 包,然后将其他所有子命令转发到 Python CLI — 因此 new、dev、pack、发布和其他生命周期动词来自 Python 包,而不是此工具。
有关精简包装器与完整工具的不同,请参阅工具(插件) 。
大纲
uip codedagent setup [--force]
uip codedagent <any-command> [args...]
uip codedagent setup [--force]
uip codedagent <any-command> [args...]
UIP 编码智能体设置
检测 Python 并验证是否已安装uipath包。结果缓存在基于用户的文件中,因此后续codedagent命令可以立即解析 Python 二进制文件。
参数
无。
选项
--force— 即使存在缓存结果,也会重新运行检测。
示例
uip codedagent setup
uip codedagent setup --force
uip codedagent setup
uip codedagent setup --force
Data shape (--output json)
{
"Code": "CodedAgentsSetup",
"Data": {
"PythonPath": "/usr/bin/python3.11",
"Package": "uipath",
"PackageInstalled": "Yes",
"PackageVersion": "1.0.0"
}
}
{
"Code": "CodedAgentsSetup",
"Data": {
"PythonPath": "/usr/bin/python3.11",
"Package": "uipath",
"PackageInstalled": "Yes",
"PackageVersion": "1.0.0"
}
}
Environment checks
- 允许的 Python 版本通过环境变量
PYTHON_TOOL_PYTHON_VERSIONS配置。空列表会在设置时引发Failure。 - 如果当前工作目录中存在
.venv目录,但未激活虚拟环境,安装程序将拒绝运行,并建议首先激活虚拟环境(在 Windows 上为.venv\Scripts\activate,在其他地方为source .venv/bin/activate)。
已转发的命令
setup 、 exec或help以外的任何子命令都会作为codedagent exec <subcommand> ...以透明方式转发到uipath Python CLI。这意味着 Python 包自己的命令界面( new 、 dev 、 run 、 pack 、 publish及其附带的任何其他内容)可以通过uip codedagent访问。
示例
# Hand off to the Python CLI's new command
uip codedagent new my-agent
# Run the Python CLI's help for a sub-verb
uip codedagent init --help
# Execute a dev loop defined by the Python package
uip codedagent dev
# Hand off to the Python CLI's new command
uip codedagent new my-agent
# Run the Python CLI's help for a sub-verb
uip codedagent init --help
# Execute a dev loop defined by the Python package
uip codedagent dev
由于这些命令由uipath Python 包定义,因此其标志和输出形式为包发出的任何标志和输出形式,而不是 CLI 的标准Code / Data信封。将此处的 CLI 视为传输。对于参数表面,请运行uip codedagent help或uip codedagent <command> --help ,两者都将转发到 Python 中。
身份验证中继:在转发之前,CLI 会读取uip login创建的会话,并将这些环境变量注入到 Python 子流程中,以便 SDK 自动选取这些变量:
UIPATH_ACCESS_TOKENUIPATH_URL(组成为<baseUrl>/<org>/<tenant>)UIPATH_ORGANIZATION_ID,UIPATH_ORGANIZATION_NAMEUIPATH_TENANT_ID,UIPATH_TENANT_NAME
如果您尚未登录,仍可转发; Python CLI 不会在没有这些变量的情况下运行。
阻止的标志:转发器拒绝将--force传递给某些破坏性的 Python 子命令(确切的列表由工具的配置层强制执行),并在发现错误时发送ValidationError 。使用错误消息建议的非--force替代方案。
退出代码
标准退出代码适用。转发的子流程的退出代码将直接中继到父 Shell,因此,当 Python 端发生故障时,会以相同的非零状态退出uip codedagent 。