Command Cheat-Sheet

In order to avoid repeating detailed command instructions over and over again throughout this documentation; please, refer to this cheat-sheet for how exactly to execute commands available in this repo.

The two commands you’ll be using are build and repo. For more details on these commands use the -h argument.

Here’s the most commonly used commands in this documentation.

Windows

build

Creates a release build in .\kit-app-template\_build directory.

Execute command in root directory of kit-app-template.

# Release build
build
# Help
build -h

repo package

Creates a package in .\kit-app-template\_build\packages directory.

Execute command in root directory of kit-app-template.

# Fat Package
repo package
# Thin Package
repo package --thin
# Fat Launcher Package
repo package --launcher
# Thin Launcher Package
repo package --launcher --thin
# Help
repo package -h

Note

Reference: Fat Package

Reference: Thin Package

repo template new

Creates an Extension in .\kit-app-template\source\extensions directory.

Execute command in root directory of kit-app-template.

Once command is executed additional options are presented.

# Create a new item from a template
repo template new
# Help
repo template -h

Omniverse Launcher Installation

Installs a package via Omniverse Launcher.

Execute command anywhere.

# Install Launcher Package
start omniverse-launcher://install?path=[absolute path to package]

Linux

build

Creates a release build in ./kit-app-template/_build directory.

Execute command in root directory of kit-app-template.

# Release build
./build.sh
# Help
./build.sh -h

repo package

Creates a package in ./kit-app-template/_build/packages directory.

Execute command in root directory of kit-app-template.

# Fat Package
./repo.sh package
# Thin Package
./repo.sh package --thin
# Fat Launcher Package
./repo.sh package --launcher
# Thin Launcher Package
./repo.sh package --launcher --thin
# Help
./repo.sh package -h

Note

Reference: Fat Package

Reference: Thin Package

repo template new

Creates an Extension in ./kit-app-template/source/extensions directory.

Execute command in root directory of kit-app-template.

Once command is executed additional options are presented.

# Create a new item from a template
./repo.sh template new
# Help
./repo.sh template -h

Omniverse Launcher Installation

Installs a package via Omniverse Launcher.

Execute command anywhere.

# May need to run these first
sudo apt-get update
sudo apt-get install xdg-utils

# Install Launcher Package
xdg-open omniverse-launcher://install?path=[absolute path to package]