Skip to Content
CLICLI reference

CLI reference

Run urus --help or urus help <topic> for the in-terminal help (with rich topics for each command).

Global options

OptionMeaning
--non-interactiveFail instead of prompting; combine with explicit flags (URUS_NON_INTERACTIVE=1 in the environment is equivalent).

Commands (summary)

CommandPurpose
initEnsure ~/.config/urus and registry exist
addRegister a bot; optional venv; optional deps install command; install systemd unit
editChange registry fields for a bot
listList registered bots
deleteRemove registry entry and uninstall Urus-managed systemd unit (does not delete project files)
start / stopsystemctl wrappers; --all where applicable
restartSame, plus optional deps when depsInstallCommand changed (or --install-deps)
statusTable of bots + state; --json for machine-readable output
logsjournalctl tail/follow
config / cfgPaths, version, settings; config get / config set
versionPrint package version

JSON output

  • urus config --json — full config snapshot
  • urus status --json{ "cliVersion", "bots": [ { ...registry row, "systemd": { ... } } ] }
  • urus cfg get … --json — subset of keys

Non-interactive add

Requires at least: --name, --runtime, --bot-dir, --entry-file. Optional: --deps-install-cmd, --python-hint, --python-no-venv, --install, --start.

See urus help add.