# Unreal Engine Command Line interface

[![build](https://github.com/Leinnan/uec/actions/workflows/rust.yml/badge.svg)](https://github.com/Leinnan/uec/actions/workflows/rust.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![crates.io](https://img.shields.io/crates/v/uec.svg)](https://crates.io/crates/uec)
[![crates.io](https://img.shields.io/crates/d/uec.svg)](https://crates.io/crates/uec)

Simple CLI tool which simplifies Unreal Engine usage from CLI. it will be single executable tool that makes easy to use it without external dependencies like Python.

It is greatly inspired by [ue4cli](https://github.com/adamrehn/ue4cli), but I have no plans for supporting Unreal Engine older that 5. In the long run, I am planing to provide similar amount of features and some additionals like command aliases specified per project and per installation.

## Usage

```sh
Unreal Engine CLI helper tool

Usage: uec [OPTIONS] <COMMAND>

Commands:
  editor                  Runs the Unreal editor without an Unreal project
  build                   Builds a Unreal project
  generate-project-files  Generate a Unreal project
  editor-project          Builds and run a Unreal editor project
  clean-project           Cleans all the intermediate files and directories from project
  set-editor              Sets the default Unreal Engine Path
  print-config            Prints the current command configuration
  build-plugin            Builds a Unreal plugin
  build-engine            Build Unreal Engine from source
  uat                     Run Unreal Automation Tool Command
  help                    Print this message or the help of the given subcommand(s)

Options:
  -e, --engine-path <ENGINE_PATH>
          Override the Unreal Engine Path from config

      --save-logs <SAVE_LOGS>
          Save logs from command into specified file

      --error-only
          Log only errors

      --dry-run
          Dry run, no command would be run. Instead it will just output what it would run

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version
```

## Install

### WinGet (Windows Package Manager)

```sh
winget install MevLyshkin.uec
```

### Manually

Go to [Releases](https://github.com/Leinnan/uec/releases) and download version for the platform of choice.

### Rust Cargo

```sh
cargo install uec
```