OpenSimulator · EN

Console: commands and diagnostics

Understand the region console, verify a change and choose the right command.

Before running any command

Enter commands in the simulator console, not in viewer chat or a regular SSH shell unless attached to the OpenSimulator console. In multi-region simulators, verify the selected region before importing an OAR.

Command or example (adapt to your installation)

help all

Find help for your installed version

Commands depend on installed versions and modules. The local console help is authoritative: use help, help all, and command-specific help when supported.

Command or example (adapt to your installation)

help
help all

Inspect the merged configuration

OpenSim.ini may be supplemented by architecture files and overrides in config/. The config show command displays the merged configuration. Compare with overrides before changing another setting.

Command or example (adapt to your installation)

config show

Inspect regions

The show region command is registered in the fork's RegionCommandsModule.cs. It reports information about the current region. On multi-region simulators, record console context before destructive actions.

Command or example (adapt to your installation)

show region

Backing up from the console

save oar and load oar operate on a region; save iar and load iar work with avatar inventory. An OAR switch is not automatically an IAR switch.

Command or example (adapt to your installation)

save oar /backups/test-before-change.oar
save iar --noassets First Last "/" PASSWORD /backups/inventory.iar

Using log files

Consult the simulator log for import failures, service outages and startup problems. Find the exact timestamp, module and first error instead of looking only at the final log line.

Command or example (adapt to your installation)

tail -n 100 OpenSim.log

Sensitive commands and security

Do not run load oar on an occupied region without a backup. Do not paste IAR passwords into public tickets. Keep production accounts and files separate from tests.

Source / Reference

Browse the detailed console command reference