ue-cli

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

CLI for controlling Unreal Engine Editor via Remote Control API (HTTP :30010).

一款通过Remote Control API（HTTP端口30010）控制Unreal Engine Editor的CLI工具。

Command	Description
`ue-cli call <objectPath> <functionName> [--params '{}']`	Call a function
`ue-cli get <objectPath> <propertyName>`	Read a property
`ue-cli set <objectPath> <propertyName> --value '{}'`	Write a property
`ue-cli describe <objectPath>`	Get object schema

命令	描述
`ue-cli call <objectPath> <functionName> [--params '{}']`	调用函数
`ue-cli get <objectPath> <propertyName>`	读取属性
`ue-cli set <objectPath> <propertyName> --value '{}'`	写入属性
`ue-cli describe <objectPath>`	获取对象架构

Command	Description
`ue-cli discover`	Browse available objects/functions (offline, from GitHub)
`ue-cli discover --detail <objectPath>`	Show function signatures with examples
`ue-cli discover --object <keyword>`	Filter by class name
`ue-cli discover --category <cat>`	Filter by category (subsystem, library)
`ue-cli info`	List all API routes (online, from UE)
`ue-cli search --query '{}'`	Search assets (online, from UE)
`ue-cli describe <objectPath>`	Full object schema (online, from UE)

命令	描述
`ue-cli discover`	浏览可用的对象/函数（离线模式，数据来自GitHub）
`ue-cli discover --detail <objectPath>`	显示带示例的函数签名
`ue-cli discover --object <keyword>`	按类名筛选
`ue-cli discover --category <cat>`	按类别筛选（子系统、库）
`ue-cli info`	列出所有API路由（在线模式，数据来自UE）
`ue-cli search --query '{}'`	搜索资源（在线模式，数据来自UE）
`ue-cli describe <objectPath>`	获取完整对象架构（在线模式，数据来自UE）

Command	Description
`ue-cli script <name> --params '{}'`	Execute a bundled Python template
`ue-cli script --list`	List available templates with parameters

命令	描述
`ue-cli script <name> --params '{}'`	执行捆绑的Python模板
`ue-cli script --list`	列出所有带参数的可用模板

Command	Description
`ue-cli batch --requests '[...]'`	Execute multiple requests

命令	描述
`ue-cli batch --requests '[...]'`	执行多个请求

Use
```
ue-cli info
```
to check API connectivity
Use
```
ue-cli discover
```
to find available objects and functions (offline — no UE connection needed)
Use
```
ue-cli describe <objectPath>
```
for full schema when exact parameter details are needed (online)
Use
```
ue-cli get
```
for reads,
```
ue-cli call
```
/
```
ue-cli set
```
for writes
For complex operations (BP creation, node wiring, UMG widgets), use
```
ue-cli script
```

Flag	Description
`--host <url>`	UE host (default: http://localhost:30010)
`--dry-run`	Preview HTTP request without sending
`--force`	Skip confirmation for write commands
`--timeout <ms>`	HTTP timeout (default: 5000)
`--verbose`	Print request/response headers
`--transaction`	Generate undo transaction (call, set)

[!CAUTION] Write commands modify editor state and are hard to undo. Use
--dry-run
first for unfamiliar operations.

[!CAUTION] 写入命令会修改编辑器状态，且难以撤销。对于不熟悉的操作，请先使用
--dry-run
预览。