Skip to content

CLI Commands

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

Terminal window
CLI="python Plugins/BlueprintAI/Scripts/cli.py"

Execute a JSON operations plan.

Terminal window
# 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

Inspect available operations and their parameter schemas.

Terminal window
# List all operations
$CLI schema
# Show full schema for one operation
$CLI schema create_blueprint
# Show schema as JSON
$CLI schema create_blueprint --json

Describe an existing asset in detail.

Terminal window
$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 the Blueprint action database for node classes.

Terminal window
# 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 a JSON operations plan without executing it.

Terminal window
$CLI validate operations.json

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

Control Play-in-Editor for verification workflows.

Terminal window
$CLI pie start
$CLI pie stop
$CLI pie state

Capture a screenshot from the editor viewport.

Terminal window
$CLI screenshot
$CLI screenshot --path /tmp/verify.png

Requires an open editor with an active viewport (not commandlet mode).

Capture a sequence of frames.

Terminal window
$CLI sequence --frames 10 --interval 0.1
$CLI sequence --frames 30 --interval 0.033 --path /tmp/frames/

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

Capture and tail editor output log.

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