Wird das Binary ohne ein Command gestartet, wird das start-Command verwendet.
Alle Commands, mit Ausnahme von
startundvalidate, beziehen sich auf eine bereits laufende Instanz.
Erzeugt ein Backup-Archiv der disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-o, --out-dir |
Ausgabe-Ordner für Backup-Archiv | ${PWD} |
✖️ |
-r, --raw |
Gibt die rohen JSON-Log-Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Das license-Command stellt die beiden Subcommands add, show und update zur Verfügung.
Mit dem add-Subcommand können Sie eine disco-io-Instanz lizenzieren.
Mit dem show-Subcommand können Sie sich die Lizenz einer disco-io-Instanz ausgeben lassen.
Mit dem update-Subcommand können Sie die Lizenz einer disco-io-Instanz aktualisieren.
Wird kein Subcommand angegeben, wird das show-Subcommand verwendet.
Lizenziert eine disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Gibt den Inhalt der Lizenz einer disco-io-Instanz auf der Kommandozeile aus.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-r, --raw |
Gibt die rohen Daten aus. | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Aktualisiert, falls möglich, die Lizenz einer disco-io-Instanz.
Das logs-Command stellt die beiden Subcommands file und ls zur Verfügung.
Mit dem file-Subcommand können sie sich den Inhalt des Log-Files auf der Kommandozeile ausgeben lassen.
Mit dem ls-Subcommand können sie sich die verfügbaren Log-Files einer laufenden disco-io-Instanz auflisten lassen.
Wird kein Subcommand angegeben, wird das ls-Subcommand verwendet.
Gibt den Inhalt eines Log-Files auf der Kommandozeile aus.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-f, --filename |
Name des auszugebenden Log-File | ✓ | |
-r, --raw |
Gibt die rohen Daten aus. | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
-v, --verbose |
Gibt zusätzliche Informationen aus | false |
✖️ |
Bei gesetzter raw-Option hat die Option verbose keinen Effekt.
Listet die Log-Files der laufenden disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-r, --raw |
Gibt die rohen JSON-Log-Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Das param-Command stellt die Subcommands action, info und update zur Verfügung.
Mit dem action-Subcommand können Sie eine Action auf einen Parameter anwenden.
Mit dem info-Subcommand können Sie sich Informationen zu einem Parameter ausgeben lassen.
Mit dem update-Subcommand können Sie einen Parameter-Value aktualisieren.
Wird kein Subcommand angegeben, wird das info-Subcommand verwendet.
Wendet die action auf den Parameter mit der ID id an.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-a, --action |
Action | ✓ | |
-i, --id. |
Parameter-ID | ✓ | |
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
--boolean. |
Boolean-Value angeben, nur bei UPDATE eines Boolean-Parameters benötigt |
✖️ | |
--index |
Index angeben, nur bei SELECTOR_INDEX benötigt |
✖️ | |
--number |
Number angeben, nur bei UPDATE einer Number-Parameters benötigt |
✖️ | |
--step |
Step-Size angeben, nur bei NUMBER_DEC und NUMBER_INC benötigt |
✖️ | |
--string |
String angeben, nur bei UPDATE einer String-Parameters benötigt |
✖️ |
Gibt Informationen zum Parameter mit der ID id aus.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-i, --id. |
Parameter-ID | ✓ | |
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Aktualisiert den Value des Parameters mit der ID id.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-i, --id. |
Parameter-ID | ✓ | |
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
--boolean. |
Nur bei Boolean-Parametern benötigt | ✖️ | |
--number |
Nur bei Number-Parametern benötigt | ✖️ | |
--string |
Nur bei String-Parametern benötigt benötigt | ✖️ |
Listet die Parameter einer disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Das param-Command stellt die Subcommands delete, docs und info zur Verfügung.
Mit dem delete-Subcommand können Sie ein Plugin löschen.
Mit dem docs-Subcommand können Sie sich die Plugin-Docs ausgeben lassen.
Mit dem info-Subcommand können Sie sich Informationen zu einem Plugin ausgeben lassen.
Wird kein Subcommand angegeben, wird das info-Subcommand verwendet.
Löscht das Plugin mit der ID id.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-i, --id |
Parameter-ID | ✓ | |
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
--plugin-version |
Plugin-Version | ✖️ |
Gibt die Docs für das Plugin mit der ID id aus.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-i, --id |
Parameter-ID | ✓ | |
-l, --locale |
Locale. | ✖️ | |
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Gibt Informationen zum Plugin mit der ID id aus.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-i, --id. |
Parameter-ID | ✓ | |
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Das plugins-Command stellt die Subcommands import und info zur Verfügung.
Mit dem import-Subcommand können Sie Plugin-Archive importieren.
Mit dem info-Subcommand können Sie sich Informationen zu den Plugins ausgeben lassen.
Wird kein Subcommand angegeben, wird das info-Subcommand verwendet.
Import Plugin-Archive in eine disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-f, --file |
Pfade zu den Plugin-Archiven | ✓ | |
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Listet die Plugins einer disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Reinitialisiert eine laufende disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Stellt ein Backup-Archiv einer disco-io-Instanz wieder her.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-f, --file |
Pfad zum Backup-Archiv | ✓ | |
-r, --raw |
Gibt die rohen JSON-Log-Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Gibt den State einer laufenden disco-io-Instanz aus.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Das start-Command startet eine disco-io-Instanz auf dem Host. Läuft bereits eine Instanz wird das Command mit einer entsprechenden Fehlermeldung beendet.
start ist das Standard-Command des Binaries.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-d, --debug |
Setzt das Log-Level auf debug |
false |
✖️ |
-h, --host |
Legt den Host fest | 0.0.0.0 |
✖️ |
-p, --port |
Legt den Host fest | 8487 |
✖️ |
-v --verbose |
Aktiviert Log-Ausgabe auf der Konsole | false |
✖️ |
--configs-dir |
Ordner für Configs | siehe Standardpfade | ✖️ |
--data-dir |
Ordner für Data. | ✖️ | |
--logs-dir |
Ordner für Logs | siehe Standardpfade | ✖️ |
--pid-file |
Aktiviert PID-File | ✖️ | |
--plugins-dir |
Ordner für Plugins | siehe Standardpfade | ✖️ |
--tls-cert |
Pfad zum TLS-Certificate | ✖️ | |
--tls-key |
Pfad zum TLS-Key | ✖️ | |
--ws |
Aktiviert WebSocket-Server | ✖️ | |
--ws-keep-alive |
Websocket-Keep-Alive-Interval | 60 |
✖️ |
Die Option --host ermöglicht es, den Netzwerkzugriff auf die App zu begrenzen. Sie kann genutzt werden um beispielsweise den Server der App an ein bestimmtes Netzwerk-Interface zu binden.
Mit der Option --data-dir ist es möglich eine Art Basispfad für den Configs-, Logs- und Plugins-Ordner anzugeben.
Mit den Optionen --configs-dir, --logs-dir und --plugins-dir kann der entsprechende Ordner zusätzlich angegeben werden.
Stoppt eine laufende disco-io-Instanz.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
-r, --raw |
Gibt die rohen Daten aus | false |
✖️ |
-u, --url |
URL der disco-io-Instanz | http://127.0.0.1:8487 |
✖️ |
Validiert die Files einem Configs-Ordner.
| Argument | Beschreibung | Default | Erforderlich |
|---|---|---|---|
--configs-dir |
Pfad zum Configs-Ordner | ✓ |