Command line utility

Einleitung

Das KeyHelp-Dienstprogramm soll Administratoren und Entwickler dabei unterstützen, auf ausgewählte KeyHelp-Funktionen zugreifen zu können.

Dieses Tool ist für eine nicht-interaktive Bedienung konzipiert.

Aufruf & Bedienung

Um auf die Funktionen des Programm zuzugreifen, verbinden Sie sich zunächst mit ihrem Server. Anschließend rufen es über folgenden Befehl über die Kommandozeile auf.

keyhelp [command]

Nach einem KeyHelp-Update kann es bis zu einer Stunde dauern, bis dieser Befehl wieder ausführbar ist.
Versuchen Sie es in diesem Fall zu einem späteren Zeitpunkt erneut.

Für  [command] setzen Sie den Namen der Funktion ein, auf die Sie zugreifen möchten.
Ein Aufruf ohne [command] zeigt die Hilfeseite des Befehls und zeigt alle zur Verfügung stehenden Funktionen an.

Funktionen

Befehl: login

keyhelp login [username]

Dieser Befehl erzeugt eine URL, mit der Sie sich bei Aufruf in das entsprechende Benutzerkonto einloggen können.

Über den Parameter [username] bestimmen Sie, für welchen Benutzeraccount die URL generiert werden soll.
Wird kein [username] angegeben wird die URL für den ersten Hauptadministrator generiert.

Die erzeugten Login-URLs sind nur für einen kurzen Zeitraum gültig.

 

Befehl: help

keyhelp help [command]

Dieser Befehl zeigt die Hilfeseite des Dienstprogramms an.

Über den Optionalen Parameter [command] können Sie sich die Hilfeseite des gewünschten Befehls anzeigen lassen.

 

Befehl: toolbox

keyhelp toolbox

Dieser Befehl öffnet das interaktive Konsolen-Programm KeyHelp-Toolbox.

 

Befehl: version

keyhelp version

Dieser Befehl zeigt Versionsinformationen an.