CLI Commands

The kumo CLI is at Plugins/Kumo/Scripts/cli.py. All commands are run from your project root.

CLI="python Plugins/Kumo/Scripts/cli.py"

apply

Execute a JSON operations plan.

# Read from a file
$CLI apply operations.json

# Read from stdin
echo '[{"op": "create_blueprint", ...}]' | $CLI apply --stdin

# Validate only, do not execute
$CLI apply operations.json --dry-run

schema

Inspect available operations and their parameter schemas.

# List all operations
$CLI schema

# Show full schema for one operation
$CLI schema create_blueprint

# Show schema as JSON
$CLI schema create_blueprint --json

inspect

Describe an existing asset in detail.

$CLI inspect /Game/Characters/BP_Enemy
$CLI inspect /Game/UI/WBP_HUD
$CLI inspect /Game/AI/BT_Enemy

Returns the full structure of the asset: components, variables, functions, nodes, graph connections, etc.

search

Search the Blueprint action database for node classes.

# Search by name or keyword
$CLI search "PrintString"
$CLI search "Move To"

# Search by pin type compatibility
$CLI search --pin-type float --output
$CLI search --pin-type "Object:Actor" --input

Search runs against UE’s live FBlueprintActionDatabase — results are always current.

validate

Validate a JSON operations plan without executing it.

$CLI validate operations.json

Returns structured errors for each invalid operation, including which field failed and why.

pie

Control Play-in-Editor for verification workflows.

$CLI pie start
$CLI pie stop
$CLI pie state

screenshot

Capture a screenshot of a Play-in-Editor window or the editor viewport.

$CLI screenshot
$CLI screenshot --label verify --folder /tmp/shots
$CLI screenshot --pie-instance 2    # a specific PIE client

During Play in Editor it reads the first client with a window (then any PIE window, then the editor viewport) unless --pie-instance names one; a named instance with no window is refused. The reply’s viewport, pie_instance and world say which viewport was read. Requires an open editor (not commandlet mode).

sequence

Capture a sequence of frames.

$CLI sequence --frames 10 --interval 0.1
$CLI sequence --frames 30 --interval 0.033 --folder /tmp/frames/
$CLI sequence --frames 10 --pie-instance 1    # a specific PIE client

Useful for verifying animations, transitions, and other time-based behavior.

logs

Capture and tail editor output log.

$CLI logs start
$CLI logs tail --max 50
$CLI logs tail --category LogAnimation --verbosity Verbose
$CLI logs stop