Skip to content

run

Run related commands

Usage:

run [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. Sentinel.UNSET

run add-module-to-descriptor

Adds the specified module entry to the descriptor file, overwriting if it already exists.

Usage:

run add-module-to-descriptor [OPTIONS] DESCRIPTOR_FILE MODULE_NAME

Options:

Name Type Description Default
--host-type choice (runtime | runtime_no_commandlet | runtime_and_program | cooked_only | uncooked_only | developer | developer_tool | editor | editor_no_commandlet | editor_and_program | program | server_only | client_only | client_only_no_commandlet | max) The host type to use. developer
--loading-phase choice (earliest_possible | post_config_init | post_splash_screen | pre_early_loading_screen | pre_loading_screen | pre_default | default | post_default | post_engine_init | none | max) The loading phase to use. default
--help boolean Show this message and exit. Sentinel.UNSET

run add-plugin-to-descriptor

Adds the specified plugin entry to the descriptor file, overwriting if it already exists.

Usage:

run add-plugin-to-descriptor [OPTIONS] DESCRIPTOR_FILE PLUGIN_NAME

Options:

Name Type Description Default
--is-enabled boolean Whether or not Enabled is ticked for the plugin entry. True
--help boolean Show this message and exit. Sentinel.UNSET

run engine

Run the engine.

Usage:

run engine [OPTIONS]

Options:

Name Type Description Default
--config-file file Path to the tempo config file Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run full-run

Builds, Cooks, Packages, Generates Mods, and Generates Mod Releases for the specified mod names.

Usage:

run full-run [OPTIONS]

Options:

Name Type Description Default
--mod-names text A mod name, can be specified multiple times Sentinel.UNSET
--toggle-engine boolean Will close engine instances at the start and open at the end of the command process False
--base-files-directory path Path to dir tree whose content to pack alongside the mod for release Sentinel.UNSET
--output-directory path Path to the output directory Sentinel.UNSET
--use-symlinks boolean Whether or not to use symlinks to save time with file operations False
--config-file file Path to the tempo config file Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run full-run-all

Builds, Cooks, Packages, Generates Mods, and Generates Mod Releases for all mod entries within the specified settings JSON.

Usage:

run full-run-all [OPTIONS]

Options:

Name Type Description Default
--toggle-engine boolean Will close engine instances at the start and open at the end of the command process False
--base-files-directory path Path to dir tree whose content to pack alongside the mod for release Sentinel.UNSET
--output-directory path Path to the output directory Sentinel.UNSET
--use-symlinks boolean Whether or not to use symlinks to save time with file operations False
--config-file file Path to the tempo config file Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run game

Run the game.

Usage:

run game [OPTIONS]

Options:

Name Type Description Default
--toggle-engine boolean Whether to close engine instances at the start and open at the end of the command process (default: False). False
--config-file file Path to the tempo config file Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run install-ue4ss

Removes the plugin name entries in the provided descriptor file if they exist.

Usage:

run install-ue4ss [OPTIONS]

Options:

Name Type Description Default
--release-tag text The release tag of the ue4ss release you want to install. Defaults to the latest release. latest
--game-exe-directory directory The directory containing the main executable for your game. Defaults to the dir that contains the game exe specified within the tempo config. Sentinel.UNSET
--config-file file Path to the tempo config file Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run kismet-analyze-directory

Generates a kismet analyzer dump for the provided directory tree.

Usage:

run kismet-analyze-directory [OPTIONS]

Options:

Name Type Description Default
--config-file file Path to the tempo config file Sentinel.UNSET
--kismet-analyzer-executable file Path to your kismet analyzer executable, if not provided, one will be automatically downloaded. Sentinel.UNSET
--mappings file Path to a jmap or usmap file. Sentinel.UNSET
--assets directory Path to an unpacked dir tree from an unreal game. D:\a\tempo-cli\tempo-cli\Modding\game_dump
--output directory The file location you want your utoc outputted to. D:\a\tempo-cli\tempo-cli\Modding\kismet_analyzer_dump
--open boolean Should the generated kismet analyzer be opened after being completed. False
--help boolean Show this message and exit. Sentinel.UNSET

run remove-modules-from-descriptor

Removes the module name entries in the provided descriptor file if they exist.

Usage:

run remove-modules-from-descriptor [OPTIONS] DESCRIPTOR_FILE

Options:

Name Type Description Default
--module-names text A module name to remove from the descriptor file, can be specified multiple times. Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run remove-plugins-from-descriptor

Removes the plugin name entries in the provided descriptor file if they exist.

Usage:

run remove-plugins-from-descriptor [OPTIONS] DESCRIPTOR_FILE

Options:

Name Type Description Default
--plugin-names text A plugin name to remove from the descriptor file, can be specified multiple times. Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run test-mods

Run tests for specific mods

Usage:

run test-mods [OPTIONS]

Options:

Name Type Description Default
--mod-names text A mod name, can be specified multiple times Sentinel.UNSET
--toggle-engine boolean Whether or not to close engine instances at the start and open at the end of the command process False
--use-symlinks boolean Whether or not to use symlinks to save time with file operations False
--config-file file Path to the tempo config file Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

run test-mods-all

Run tests for all mods within the specified settings JSON

Usage:

run test-mods-all [OPTIONS]

Options:

Name Type Description Default
--toggle-engine boolean Whether or not to close engine instances at the start and open at the end of the command process False
--use-symlinks boolean Whether or not to use symlinks to save time with file operations False
--config-file file Path to the tempo config file Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET