Zum Inhalt

CLI-Referenz

Befehle verwenden dieses Format

Befehlssyntax
telegram-commander <command> [flags]

--config / -c ist für Befehle, die eine Konfiguration laden, erforderlich. Der Pfad kann relativ zum aktuellen Arbeitsverzeichnis oder absolut sein. Der Inhalt dieser Datei ist unter Konfiguration dokumentiert.

Wenn Sie gerade erst beginnen, zeigt In der CLI ausführen diese Befehle in der Reihenfolge, in der Sie sie verwenden werden.

Befehle

run

Den Bot im Vordergrund ausführen.

Den Bot im Vordergrund starten

Den Bot ausführen
telegram-commander run --config /path/to/configfile.yaml

Konfigurationsänderungen erfordern einen Neustart

Der Bot liest die Konfiguration einmalig beim Start. Starten Sie den Prozess nach einer Dateiänderung neu (zum Beispiel mit systemctl restart telegram-commander).

validate

Konfiguration, Funktionen und Schaltflächenverweise offline validieren.

Die Konfiguration offline oder online prüfen

Die Konfiguration validieren
telegram-commander validate --config /path/to/configfile.yaml
telegram-commander validate --config /path/to/configfile.yaml --online

--online benötigt Internetzugriff

Mit --online fragt die Prüfung zusätzlich bei Telegram nach, ob das Bot-Token funktioniert. Der Rechner muss Telegram daher erreichen können.

version

Die Programmversion ausgeben.

fmt

Eine YAML-Konfigurationsdatei formatiert ausgeben.

Formatiertes YAML ausgeben oder speichern

Eine Konfigurationsdatei formatieren
telegram-commander fmt --config /path/to/configfile.yaml
telegram-commander fmt --config /path/to/configfile.yaml -w

environ

Umgebungsvariablen des Prozesses ausgeben (hilfreich bei der Fehlersuche in Dienst-Units).

list-functions

Integrierte und geladene eigene Funktionen auflisten. Damit können Sie prüfen, ob Ihre eigenen Funktionsdateien gefunden wurden. Siehe Funktionen.

Alle verfügbaren Funktionen anzeigen

Verfügbare Funktionen auflisten
telegram-commander list-functions --config /path/to/configfile.yaml

completion

Skripte zur Shell-Vervollständigung erzeugen:

Die verwendete Shell auswählen

Ein Vervollständigungsskript erzeugen
telegram-commander completion bash
telegram-commander completion zsh
telegram-commander completion fish
telegram-commander completion powershell

manpage

Eine Handbuchseite auf stdout schreiben.

Verwandte Seiten