Getting Started#

For now, the CLI is only available for Windows. The CLI will be available for other operating systems in the future.

Prerequisites#

• OpenBOR executable - You need to have the OpenBOR executable on your computer. You can download it from Chrono Crash.
• (Optional) Git - If you want to use the remote template feature, you must install Git.
• (Optional) Visual Studio Code - It's my favorite code editor. Since it integrates a terminal and text editor, it is very convenient with the CLI. But you can use any terminal and text editor you like.

Installation#

1. Download the latest version of the CLI (uobors_cli-vX.X.X.zip) from the releases page.
2. Extract the zip file's contents to a folder on your computer you like.
3. (Optional) If you want to use the CLI from any directory, add the path to the CLI to your system's PATH environment variable.

Executing the CLI#

1. Open a PowerShell or Command Prompt window. If you don't add the path to the CLI to your system's PATH environment variable, you need to navigate to the folder where you extracted the CLI.

2. Enter the following command to check the CLI version.

   .\uobors_cli.exe --version

3. Enter the following command to check the CLI help.

   .\uobors_cli.exe --help

Create the CLI configuration file#

1. Execute the following command in your terminal to create the CLI configuration file

Create a minimal sample project#