Handbuch · API · CLI

01Web-Anwendung

Die Web-Anwendung läuft vollständig im Browser. PDF-, DOCX- und TXT-Dateien werden lokal geparst; die Regelmaschine (47 Detektoren) arbeitet client-seitig. Es gibt keinen Upload an einen Server und kein Konto, das Inhalte speichert.

Oberfläche	Funktion
Startseite	Schnellprüfung einzelner Verträge, Risiko-Score, JSON- und PDF-Export
ClauseLens Studio	Mehrseitiges Dokumentenaudit, Redline-Vorschläge, Vergleich von Vertragsversionen

Laden Sie eine Datei über das Feld Datei auswählen oder ziehen Sie sie in den Editor. Ohne Datei können Sie Text einfügen. Die Vorlagen SaaS-AGB, Softwarevertrag, Konformer Vertrag und Freelancer-Vertrag sind Beispiele und laufen ohne Verbrauch des Testkontingents.

02Testkontingent

Auf der Startseite sind 3 Prüfungen eigener Verträge kostenlos, danach ist eine Lizenz erforderlich. Der Zähler steht neben der Zeichenanzahl („3 von 3 Test-Prüfungen verbleibend“) und wird im Browser gespeichert, nicht auf einem Server.

Ein Klick auf einen Vorlagen-Button oder ein Seitenaufruf mit Vorlage verbraucht keine Prüfung.
Hochgeladene Dateien und selbst eingefügter Text verbrauchen eine Prüfung.
Eine Lizenz schaltet unbegrenzte Prüfungen auf dem Gerät frei.

Das Kontingent ist ein Testangebot, keine technische Sperre. Für Kanzleien und Teams empfiehlt sich die aktivierte Lizenz mit Rechnung.

03Kommandozeile (CLI)

Die CLI ist die On-Premise-Variante für Skripte, Batch-Prüfungen und die Anbindung an eigene Prozesse. Sie benötigt Node.js ≥ 18 und keine externen Pakete. Die Distribution erhalten Sie mit dem Lizenzpaket (Pro/Team) als Archiv; entpackt liegen bin/clauselens.js und src/ im selben Verzeichnis.

# Installation im entpackten Verzeichnis prüfen
node -v                      # Node.js >= 18
node bin/clauselens.js -h    # Befehlsübersicht

# Einzelvertrag prüfen und PDF-Bericht schreiben
node bin/clauselens.js analyze vertrag.pdf --pdf befund.pdf

Auf Wunsch startet npm start zusätzlich den lokalen Webserver mit Studio und REST-API (siehe Lokaler Server).

04Einzelvertrag: `analyze`

node bin/clauselens.js analyze vertrag.pdf                 # Terminübersicht
node bin/clauselens.js analyze vertrag.pdf --pdf audit.pdf  # DIN-A4 Vektor-PDF, versiegelt
node bin/clauselens.js analyze vertrag.docx --json r.json --report r.md
node bin/clauselens.js analyze agb.txt --html bericht.html  # interaktiver HTML-Bericht
node bin/clauselens.js analyze vertrag.pdf --sarif results.sarif  # SARIF 2.1.0 für CI

Option	Wirkung
`--pdf <pfad>`	Mehrseitiger DIN-A4-Bericht mit SHA-256-Siegel
`--html <pfad>`	Interaktiver Bericht mit SVG-Gauges, Filtern, Redline-Kopierfunktion
`--json <pfad>`	Schema-konformes JSON
`--report <pfad>`	Markdown-Risikobericht
`--sarif <pfad>`	OASIS SARIF 2.1.0 für GitHub Code Scanning
`--format <fmt>`	`auto` (Standard), `txt`, `pdf`, `docx` erzwingen
`--profile <name>`	`default`, `b2b_saas`, `freelance_consulting`, `procurement_strict`
`--config <pfad>`	Schwellenwerte, Gewichte und Regelauswahl aus `clauselens.config.json`
`--license <key>`	Lizenzschlüssel, alternativ `CLAUSELENS_LICENSE_KEY`

05Portfolio: `batch` und `compare`

# Alle Verträge eines Ordners prüfen
node bin/clauselens.js batch ./vertraege --html portfolio.html --json portfolio.json

# Original gegen Gegenentwurf vergleichen (Risikodelta)
node bin/clauselens.js compare entwurf_v1.docx gegenentwurf_v2.docx --report delta.md

batch liefert einen aggregierten Portfolio-Score, die Verteilung hoher und mittlerer Risiken sowie die häufigsten Risikoklauseln. compare beziffert die Punkteveränderung, zeigt behobene Risiken und markiert neu eingeschleuste Klauseln.

06Seat-Verwaltung: `login`, `register`, `whoami`, `logout`

node bin/clauselens.js register --email kanzlei@beispiel.de --name "Kanzlei Beispiel"
node bin/clauselens.js login --email kanzlei@beispiel.de --key CL-PRO-...
node bin/clauselens.js whoami     # Account, Gerät, Seat-Status
node bin/clauselens.js logout     # Seat auf diesem Gerät freigeben

Der Seat wird an einen Geräte-Fingerprint gebunden, damit eine Lizenz nicht beliebig oft installiert werden kann. Pro-Lizenzen umfassen einen Arbeitsplatz, Team-Lizenzen mehrere. Wenn Sie den Rechner wechseln, geben Sie den Seat zuerst mit logout frei und aktivieren ihn auf dem neuen Gerät.

Die Web-Anwendung braucht keine Seat-Aktivierung: Dort genügt das Eintragen des Lizenzschlüssels im Lizenzfenster.

07Lokaler Server und Studio

node bin/clauselens.js serve --port 3000
# oder
npm start

Adresse	Inhalt
`/`	Startseite mit interaktiver Prüfung
`/app`	ClauseLens Studio (Dokumentenaudit, Redlines)
`/docs`	OpenAPI-Explorer der REST-API
`/api/v1/...`	REST-Endpunkte

Der Server bindet standardmäßig nur lokal. Für den Betrieb im Netz setzen Sie hinter einem Reverse-Proxy und schützen Sie den Zugang; die Engine selbst benötigt keinen Internetzugang.

08REST-API

Die API läuft auf Ihrem eigenen Server, gestartet mit serve. Auf dieser Website ist sie nicht aktiv. Basis-URL: http://localhost:3000/api/v1.

Methode	Pfad	Zweck
GET	`/api/v1/health`	Status, Engine-Version, Uptime
GET	`/api/v1/rules`	Katalog aller Detektoren und Profile
GET	`/api/v1/openapi.json`	OpenAPI-3.0-Spezifikation
POST	`/api/v1/extract`	Text aus PDF/DOCX extrahieren (Binärkörper)
POST	`/api/v1/analyze`	Vertragstext analysieren, optional `?format=pdf`
POST	`/api/v1/compare`	Zwei Versionen vergleichen, Risikodelta

curl http://localhost:3000/api/v1/health

curl -X POST http://localhost:3000/api/v1/analyze \
  -H "Content-Type: application/json" \
  -d '{"text":"Die Haftung ist für sämtliche Schäden ausgeschlossen.","profile":"default"}'

curl -X POST http://localhost:3000/api/v1/extract \
  -H "Content-Type: application/octet-stream" \
  --data-binary @vertrag.pdf

Die Antwort enthält Score, Risikostufe, die Befunde mit Zeilenbereich, Begründung und Gegenvorschlag sowie die Zählung nach Schweregrad. Fehler kommen als JSON mit error und message.

09Lizenz und Aktivierung

Lizenzen werden über Polar.sh als Merchant of Record verkauft. Nach dem Kauf erhalten Sie einen Schlüssel, der mit LENS- oder CL- beginnt.

Web: im Lizenzfenster (Symbol oben rechts) Schlüssel eintragen und „Aktivieren“ wählen.
CLI: login --email ... --key ... oder --license bei jeder Analyse.
Team: jeder Arbeitsplatz bekommt einen eigenen Seat; die Anzahl richtet sich nach dem gebuchten Paket.

Die Aktivierung erfolgt online, die Analyse danach offline. Es gilt die gesetzliche Widerrufsfrist; Zahlung und Rechnung laufen über Polar. Details stehen in Preise & Lizenzen.

10Prüfumfang und Grenzen

ClauseLens prüft 47 Klauseltypen aus dem AGB-Recht (§§ 305–310 BGB) und erkennt typische Risikomuster, etwa automatische Verlängerungen, Haftungsausschlüsse, einseitige Änderungsrechte, Gerichtsstands- und Rechtswahlklauseln. Jeder Befund hat einen Schweregrad (hoch, mittel, niedrig), eine Begründung in Alltagssprache und einen Gegenvorschlag.

Die Prüfung ist eine kaufmännische Vorprüfung (Audit Aid gemäß §§ 1, 2 RDG) und keine Rechtsberatung. Sie ersetzt keine anwaltliche Bewertung und ist keine Vollständigkeitsgarantie. Die Engine arbeitet deterministisch: gleicher Text, gleiches Ergebnis, ohne Modellaufruf und ohne Datenabfluss.

Zeigen Sie Befunde stets im Kontext des Gesamtvertrags. Einzelne Klauseln können durch Individualabrede oder ergänzende Verträge abweichen.