​
Install the CLI

Download the latest stable release for your platform from Github Releases

./runreal-linux-x64 -h

Output:

Usage:   runreal
Version: latest

Description:

  the Unreal Engine runner

Options:

  -h, --help                        - Show this help.
  -V, --version                     - Show the version number for this program.
  --session-id       <sessionId>    - Session Id                                 (Default: "01HV4G8HQHW5H4H5FH8WQJYN23")
  --log-level        <level>        - Log level                                  (Default: "DEBUG", Values: "DEBUG", "INFO", "ERROR")
  -c, --config-path  <configPath>   - Path to config file
  --engine-path      <enginePath>   - Path to engine folder
  --project-path     <projectPath>  - Path to project folder
  --build-id         <buildId>      - Overide build ID
  --build-path       <buildPath>    - Path to save build outputs

Commands:

  init                             - init
  debug                            - run
  clean                            -
  build       <target>             - build
  engine                           - engine
  uat         <command> [args...]  - uat
  ubt         <command> [args...]  - ubt
  pkg                              - package
  buildgraph                       - buildgraph
  workflow                         - workflow

Environment variables:

  RUNREAL_ENGINE_PATH   <enginePath>   - Overide path to engine folder
  RUNREAL_PROJECT_PATH  <projectPath>  - Overide path to project folder
  RUNREAL_BUILD_PATH    <buildPath>    - Overide path to build output folder
  RUNREAL_BUILD_ID      <buildId>      - Overide build ID

​
Installing from source

Prerequisite You should have Deno installed.

git clone git@github.com:runreal/cli.git
cd cli
deno task install

Output:


Task install deno install -A --force --global --name runreal src/index.ts
✅ Successfully installed runreal
/Users/user/.deno/bin/runreal
ℹ️  Add /Users/user/.deno/bin to PATH
export PATH="/Users/users/.deno/bin:$PATH"

Add runreal to your path by adding the last line to your .bashrc or revelent shell.

IntroductionConfig File