Usage Examples

Set and Clear Client Aliases

import carb.settings
import omni.client

# Path for alias settings
ALIAS_SETTINGS_PATH = "/app/client/aliases"
settings = carb.settings.get_settings()

# Original path and file details
origin_path = "origin://folder"
file_name = "test.txt"
origin_url = origin_path + "/" + file_name
redirect_path = "/path/to/redirect"

# Attempt to stat origin://folder/test.txt
result, _ = omni.client.stat(origin_url)

# Set alias origin://folder -> /path/to/redirect
settings.set(ALIAS_SETTINGS_PATH, [{"alias": origin_path, "path": redirect_path}])

# Actually stat /path/to/redirect/test.txt now with alias configured
result, _ = omni.client.stat(origin_url)

# Clear alias
settings.set(ALIAS_SETTINGS_PATH, [])

# Attempt to stat origin://folder/test.txt again since alias is cleared
result, _ = omni.client.stat(origin_url)