Składnia linii komend

sowizor [opcje-programu] polecenie [parametry] [opcje-polecenia]

opcje-programu

Są to niezależne od polecenia opcje zmieniające tryb pracy programu. W szczególności dostępne są opcje:
-h (lub --help) - nie wykonuje żadnego polecenia, tylko wyświetla pomoc na temat programu lub konkretnego polecenia (np. sowizor start --help wyświetli pomoc na temat polecenia start)
--version - nie wykonuje żadnego polecenia, tylko wyświetla informację o wersji programu
-v (lub --verbose) - włącza tzw. tryb "gadatliwy" - powoduje wypisywanie na ekran znacznie bogatszej informacji (często pełnej sformułowań czysto technicznych). Przydatny przy rozwiązywaniu problemów. Opcję tę można podać dwukrotnie, co spowoduje włączenie trybu debug.
--daemon - powoduje przekierowanie komunikatów z ekranu do pliku logu (sowizor.log lub plik wskazany opcją --log-file)
--log-file <ścieżka> - ustawia ścieżkę do pliku dziennika (domyślnie sowizor.log)

polecenie

Nazwa wykonywanego polecenia. Pomoc na temat poszczególnych poleceń można uzyskać dodając dla polecenia opcję --help.

Dostępne polecenia: config, report, start, stop, restart, status, install, upgrade, uninstall, list, enable, disable, scan, add, remove, rename, set, export, import, log, migrate, update, reindex, licence, adm, edit, schedule, ipub, backup

parametry

Lista parametrów zależy od polecenia. Większość poleceń wymaga co najmniej jednego parametru, a wywołanie go bez parametrów powoduje wyświetlenie informacji o składni danego polecenia i oczekiwanych parametrach.

opcje-polecenia

Niektóre polecenia mogą dopuszczać dodatkowe opcje, zmieniające sposób wykonywania polecenia. Wszystkie opcje mają postać --nazwa. Muszą one zawsze znajdować się za lub przed wszystkimi parametrami polecenia (nie można ich "wplatać" między parametry)

Składnia większości poleceń jest prosta, ale w najbardziej skomplikowanych wariantach może przyjąć np. taką formę:

sowizor --verbose migrate katalog_mbp_ks start --ignore-params --generate-services