Bedienung des CLI (Kommandozeilenclient)#

Hier die ersten Schritte mit dem CLI. In der Darstellung sehen wir Terminal Ausgaben aus einer bash. Grundsätzlich funktioniert das natürlich mit allen shells.

Bei Beispielen, in denen Ausgaben zu sehen sind, haben wir den Befehlen Prompts vorangestellt ($), um die Befehle zu kennzeichnen und die Ausgaben zu separieren. In Beispielen ohne Ausgabe bzw. in Beispielen bei denen die Ausgabe irrelevant ist, haben wir die Prompts bewusst weg gelassen, damit Sie diese leichter per Copy & Paste verwenden können. Zum Kopieren klicken Sie in das Feld, bis Sie einen blauen Rahmen sehen. Das markiert den kompletten Text.

Einmalige Vorbereitung#

Laden Sie sich die letzte Version des Kommandozeilen-Clients herunter.
Diese finden Sie auf der Download Seite oder auch direkt im git.

Wenn Sie Windows verwenden, nehmen Sie diesen Download.
Windows Anwender? Öffnen Sie ein Kommando Fenster

Unter Windows, öffnen Sie ein Kommandozeilen-Fenster (cmd, Powershell oder bash wenn vorhanden) in dem Verzeichnis, wohin sie den Client geladen haben. Am besten legen Sie den Client in ein Verzeichnis im Pfad, dann können sie ihn immer und von überall aus starten (z.B. von dem Verzeichnis, wo ihre CSV Dateien liegen)

Wir empfehlen auch, das geladene Programm der Einfachheit halber in livectl.exe umzubenennen. Die weiteren Beispiele sind Betriebssystemunabhängig und funktionieren sowohl auf Windows, Mac und Linux gleichsam.

Prüfen Sie die Version

$ livectl version
Client: lab Version 0.8.0 (289) [BuildVersion: 1760711093670 from 2025-10-17T14:24:53Z]

Im Schritt zuvor sehen wir, dass der Server nicht erreichbar ist. Das liegt daran, dass der Server noch nicht konfiguriert wurde:
```
livectl server https://app.inkasso.live
```
Falls Sie den Server häufig wechseln (zwischen einem Test System und z.B. localhost) gibt es auch passende Shortcuts, z.B. livectl app und livectl local.
Die einzelnen Kommandos von livectl finden Sie in der Hilfe:
```
livectl help
```
Oder für Sub-Kommandos:
```
livectl debtor --help
```
Sie können die Sprache der Hilfe-Seiten mit Hilfe von livectl language de z.B. auf Deutsch ändern. Die Kommandos bleiben aber die gleichen.
Registrieren Sie sich am Server

Die Registrierung funktioniert mit dem CLI identisch zu der App, nur das hier statt Fingerabdruck das sichere Systemlogin verwendet wird.
```
livectl register <token>
```
Melden Sie sich am Server an

Die Authentifizierung baut während des Login Prozesses eine gesicherte Verbindung zum Server auf:
```
livectl login
```

Sie können nun alle Kommandos verwenden, für die Sie berechtigt sind.

Beispiel: Import#

Hier ein Beispiel für einen Import mit livectl:

Angenommen Sie haben eine csv Datei mit Postleitzahlen, so können Sie diese wie folgt importieren:

livectl plz import daten.csv

livectlerkennt das Format automatisch. Falls das mal nicht klappt, können Sie das Format auch mit -f <format> erzwingen.

Beispiel Import mit fehlerhaften Daten#

Hier eine csv Datei mit 353 Einträgen. Der Client prüft die Daten, bevor sie zum Server geschickt werden:

$ livectl auftrag import test1.csv 
*** 63/353 ***
Schuldner Anrede: Pflichtfeld
Schuldner Vorname: Pflichtfeld
*** 151/353 ***
Hauptforderung, Kosten und Gesamtforderung müssen gesetzt sein.
exit status 1

Man bekommt hier eine Anzeige, in welchen Zeilen und in welchen Feldern Fehler gefunden wurden.

Der Client bereinigt csv Daten, bevor sie verwendet werden. Oft sind es fehlende Anführungszeichen, ggf. unerlaubte Zeilenumbrüche in Spalten oder falsche Datums- oder Währungsformate. Der Client versucht so gut es geht diese Dinge zu korrigieren. Falls das nicht gelingt, gibt es passende Fehlermeldungen:

$ livectl auftrag import test2.csv 
*** 9/11 ***
Gesamtforderung: Die Gesamtforderung (262.06 != Summe 144.30) muss der Hauptforderung (55.34) zzgl. Kosten (48.20) und optional Zinsen (40.76) entsprechen
BezeichnungRatenzahlungsvereinbarung: Pflichtfeld
GebuehrRatenzahlungsvereinbarung: Pflichtfeld
exit status 1

Oder

$ livectl auftrag import test3.csv 
Unbekannte Spalte: , , , 
Error reading: invalid CSV: setFieldFromString error in row 0 col 14: invalid currency format: 'keine Vorgabe' - cannot parse currency string: "keine Vorgabe"
exit status 1

Export#

Sie können alle Objekte in allen gängigen Formaten exportieren. Hier ein Beispiel für Aufträge als csv:

livectl auftrag export aufträge.csv -f csv

Wenn Sie kein Format angeben, erkennt livectl das gewünschte Dateiformat am Dateinamen.