https://github.com/runreal/cli
The easiest way to build your Unreal Engine project
https://github.com/runreal/cli
cli deno unreal unreal-engine
Last synced: 9 months ago
JSON representation
The easiest way to build your Unreal Engine project
- Host: GitHub
- URL: https://github.com/runreal/cli
- Owner: runreal
- License: mit
- Created: 2024-03-16T03:12:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-11T19:17:19.000Z (9 months ago)
- Last Synced: 2025-09-11T22:21:01.445Z (9 months ago)
- Topics: cli, deno, unreal, unreal-engine
- Language: TypeScript
- Homepage: https://docs.runreal.dev/cli
- Size: 715 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# runreal cli
The open-source Unreal Engine toolkit.
Documentation »
Website
·
Twitter
·
Discord
- **Unreal Engine**: Configure your engine, build projects, and run UAT/UBT commands.
- **Buildgraph**: Easily work with BuildGraph.
- **Project**: Compile, package, and run projects easily.
- **Workflow**: Execute custom workflows for your Unreal Engine projects.
- **Asset Management**: Work with Unreal assets using the uasset commands.
## Getting Started
```sh
# Build the editor
runreal project build Editor
# Build your project targets
runreal project build Client
# List available build targets
runreal info list-targets
# Run your editor
runreal run Editor
# Run your game
runreal run Game
# Package your project
runreal project pkg Game Win64 Development nopak
# Execute a buildgraph script
runreal buildgraph run
# Run UAT commands
runreal uat run BuildCookRun -project=YourProject.uproject
# Run UBT commands
runreal ubt run -Mode=QueryTargets
```
## Installation
Download the latest release from the [Releases](https://github.com/runreal/cli/releases/latest) page.
### Install Latest Version
**With PowerShell:**
```powershell
irm https://raw.githubusercontent.com/runreal/cli/refs/heads/main/install.ps1 | iex
```
**With Shell:**
```sh
curl -fsSL https://raw.githubusercontent.com/runreal/cli/refs/heads/main/install.sh | sh
```
### Install Specific Version
**With PowerShell:**
```powershell
$v="1.0.0"; irm https://raw.githubusercontent.com/runreal/cli/refs/heads/main/install.ps1 | iex
```
**With Shell:**
```sh
curl -fsSL https://raw.githubusercontent.com/runreal/cli/refs/heads/main/install.sh | sh -s v1.0.0
```
## Usage
```sh
runreal --help
Usage: runreal
Version: 1.6.0
Description:
the Unreal Engine runner
Options:
-h, --help - Show this help.
-V, --version - Show the version number for this program.
--session-id - Session Id (Default: "01JTVDP0Z1N2ES4703Y44MQTFQ")
--log-level - Log level (Default: "DEBUG", Values: "DEBUG", "INFO", "ERROR")
-c, --config-path - Path to config file
--engine-path - Path to engine folder
--project-path - Path to project folder
--build-id - Overide build ID
--build-path - Path to save build outputs
--build-ts - Overide build timestamp
Commands:
init - init
debug - debug
list-targets - list-targets
engine - engine
uat [args...] - uat
ubt [args...] - ubt
buildgraph - buildgraph
workflow - workflow
script - script
auth [args...] - auth
uasset - uasset
project - project
Environment variables:
RUNREAL_ENGINE_PATH - Overide path to engine folder
RUNREAL_PROJECT_PATH - Overide path to project folder
RUNREAL_BUILD_ID - Overide build ID
RUNREAL_BUILD_PATH - Overide path to build output folder
RUNREAL_BUILD_TS - Overide build timestamp
```
## Building from source
`deno` is required. See [deno getting started](https://docs.deno.com/runtime/getting_started/installation/).
1. Clone the cli
```bash
git clone https://github.com/runreal/cli
```
2. Install dependencies
```bash
deno install
```
3. Run the cli in dev mode
```bash
deno task dev
```
### Compiling to binaries
```bash
deno task compile-win
deno task compile-linux
deno task compile-macos
```
### Changelog
See the [CHANGELOG](CHANGELOG.md) for a list of changes.
### License
MIT [LICENSE](LICENSE)