> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI schützen

> Zeichnen Sie Dateifingerabdrücke von einem Verbraucherkonto oder Geschäftsarbeitsbereich auf und verifizieren Sie dann die Originaldatei.

Zeichnen Sie den SHA-256-Fingerabdruck einer Datei auf und verifizieren Sie ihn später mit Truthlocks. Dateien sind
lokal gehasht: die CLI sendet den Fingerabdruck und die Datensatzmetadaten, nicht den Dateiinhalt.

**Laufzeit:** Node.js 18+ · **Paket:** `@truthlocks/protect` · **Befehl:** `truthlock-protect`

[Console](https://console.truthlocks.com) · [Verbraucher-App](https://verify.truthlocks.com) · [API-Dokumentation](https://docs.truthlocks.com)

## Installation

```sh theme={null}
npm install --global @truthlocks/protect
truthlock-protect --help
```

Der Befehl `truthlocks` ist auch als Alias installiert. Dieses Paket zeichnet online auf
Fingerabdrücke; verwenden Sie `@truthlocks/cli` für die Offline-Verifizierung von Proof-Bundles.

## Kontotyp auswählen

| Konto | Anmeldeinformationen | Signatur-Setup |
| - | - | - |
| Geschäftsbereich | `TRUTHLOCKS_API_KEY` | Ein aktiver Aussteller und ein Schlüssel, der in der Konsole zum Signieren verfügbar ist. |
| Verbraucherkonto | `TRUTHLOCK_TOKEN` | Ein autorisiertes Verbraucher-Bearer-Token; Truthlocks verwaltet seinen Signierschlüssel. |

Ein API-Schlüssel ist kein Verbraucher-Token. Die CLI verwendet unterschiedliche Endpunkte für diese beiden
Workflows. Test-API-Schlüssel wählen den Sandbox-Host aus. Setzen Sie `TRUTHLOCK_API_URL` nur, wenn
Sie absichtlich einen anderen API-Ursprung benötigen.

## Arbeitsbereichs-Schnellstart

Setzen Sie `TRUTHLOCKS_API_KEY`, `TRUTHLOCKS_ISSUER_ID` und `TRUTHLOCKS_KEY_ID` in Ihrer Umgebung,
dann eine bestehende Datei schützen:

```sh theme={null}
truthlock-protect whoami
truthlock-protect protect ./report.pdf --title "Quarterly report" --idempotency-key report-release-2026-10-11 --output ./report.receipt.json --json
```

Ersetzen Sie den Beispiel-Wiederholungsschlüssel durch einen eindeutigen Wert für diesen Vorgang. Behalten Sie ihn bei mit
die Anfragedetails und verwenden Sie sie nur für die identische Anfrage. Die Ausgabe enthält
`attestation_id` und `payload_b64url`; beide behalten. Die Option `--output` speichert eine Quittung, ohne eine vorhandene Datei zu überschreiben. Dieser Vorgang schreibt einen Datensatz.

Sie können stattdessen den Aussteller und den Schlüssel explizit auswählen:

```sh theme={null}
truthlock-protect protect ./report.pdf --issuer-id YOUR_ISSUER_UUID --key-id YOUR_SIGNING_KEY_ID --algorithm Ed25519 --json
```

Ersetzen Sie die Großbuchstaben-Platzhalter. Der Algorithmus muss dem ausgewählten Schlüssel entsprechen. Wenn
genau ein aktiver Aussteller und ein berechtigter Signierschlüssel verfügbar sind, kann die CLI
wählen Sie diese automatisch aus; andernfalls werden Sie aufgefordert, diese mithilfe von Flags auszuwählen.

Arbeitsbereichsdatensätze verwenden strukturierte Claims mit einem `document.sha256` Fingerabdruck und einem
expliziter Dokument-Hash. Sie folgen den Arbeitsbereichs-/API-Zugriffsregeln; die Sichtbarkeit des Verbrauchers
Flags gelten nicht für diesen Workflow.

## Consumer-Schnellstart

Setzen Sie `TRUTHLOCK_TOKEN` auf einen autorisierten Consumer-Bearer-Token mit Workspace-API-Schlüssel
Umgebungsvariablen nicht gesetzt, dann ausführen:

```sh theme={null}
truthlock-protect whoami
truthlock-protect protect ./design.png --title "Design source" --private --output ./design.receipt.json --json
```

Verbraucherdatensätze sind standardmäßig privat. Verwenden Sie `--public` nur, wenn Sie eine öffentliche
Verbraucherdatensatz. Der Dienst wählt den Signierschlüssel des Verbrauchers aus; `--algorithm`,
`--issuer-id` und `--key-id` sind Arbeitsbereichsoptionen und werden im Verbrauchermodus abgelehnt.

## Einen Datensatz und eine Datei verifizieren

Verwenden Sie den gespeicherten Beleg und die Originaldatei. Der Beleg liefert die exakten Bytes
die signiert wurden; die Datei liefert den zu vergleichenden Fingerabdruck:

```sh theme={null}
truthlock-protect verify --receipt ./report.receipt.json --file ./report.pdf --json
```

Für einen aktuellen Verbraucherdatensatz können Sie dessen definierten personal-record-v2 rekonstruieren
Payload aus der Originaldatei:

```sh theme={null}
truthlock-protect verify YOUR_ATTESTATION_UUID --personal-record --file ./design.png --json
```

Diese Rekonstruktion erfolgt automatisch, wenn nur ein Consumer-Token mit `--file` verwendet wird.
Es rekonstruiert keine beliebigen Workspace-Ansprüche oder historischen Payload-Formate.
Für einen Workspace-Datensatz ohne gespeicherten Beleg, liefern Sie die ursprüngliche signierte Nutzlast
Bytes mit `--payload-file ./signed-payload.json`. Formatieren Sie dieses JSON nicht neu.

Exit-Code 0 erfordert sowohl `verdict: VALID` als auch `signature_verified: true`.
Geänderte Dateien und unvollständige Nachweise beenden sich ungleich Null. Eine ID-basierte Suche kann nicht verifizieren
eine Signatur; es meldet `INCOMPLETE`, es sei denn, ein stärkerer Status wie der Widerruf trifft zu:

```sh theme={null}
truthlock-protect verify YOUR_ATTESTATION_UUID --json
```

Ein gültiger Fingerabdruckdatensatz ist ein Beweis dafür, dass Bytes mit dem aufgezeichneten Hash übereinstimmen. Er tut es
beweist nicht unabhängig die Urheberschaft, das Urheberrecht oder die Wahrheit seines Titels.

## Befehle

| Befehl | Zweck |
| - | - |
| `protect <file>` / `p <file>` | Den Fingerabdruck einer regulären Datei aufzeichnen. |
| `verify [id] --receipt <path> --file <path>` | Überprüfen Sie die beibehaltene signierte Nutzlast und vergleichen Sie die Originaldateibytes. |
| `list [--limit 20] [--json]` | Datensätze lesen, die dem konfigurierten Konto zur Verfügung stehen. |
| `whoami` | Überprüfen Sie den Arbeitsbereichszugriff oder die Kontoinformationen des Verbrauchers. |
| `login --token <token>` | Speichern Sie ein Verbraucher-Token lokal. Umgebungsvariablen vermeiden das Speichern. |
| `logout` | Entfernt das gespeicherte Verbraucher-Token; Umgebungsvariablen und Arbeitsbereichs-Anmeldeinformationen bleiben erhalten. |
| `register --email <email>` | Registrieren Sie einen Entwickler-Arbeitsbereich und speichern Sie dessen Sandbox-API-Schlüssel. |

Die Entwicklerregistrierung ist ein separater Vorgang zur Kontoerstellung. Sie erstellt keine
eine Verbrauchersitzung oder garantieren, dass ein Aussteller/Signierschlüssel bereits bereitgestellt ist.

## Optionen und lokaler Speicher

`protect` akzeptiert `--title`, `--description`, `--category`, `--content-type`, `--json`,
`--api-key`, `--issuer-id`, `--key-id`, `--algorithm`, `--idempotency-key` und `--output`.
`--public` und `--private` gelten nur für Verbraucher. Die Dateikategorie wird automatisch erkannt, sofern nicht angegeben. Verzeichnisse werden nicht unterstützt.

Die historische Variable `TRUTHLOCK_API_KEY` wird weiterhin akzeptiert. Explizite API-Schlüssel-Flags
und Umgebungsvariablen haben Vorrang vor einem gespeicherten Entwicklerschlüssel. Ein expliziter
Die Umgebungsvariable consumer-token hat Vorrang vor einem gespeicherten Entwicklerschlüssel, wenn
keine API-Schlüssel-Umgebungsvariable angegeben wird.

Ein gespeichertes Verbraucher-Token befindet sich in `~/.truthlock/config.json`; Entwickler-Anmeldeinformationen befinden sich
in `~/.truthlocks/credentials.json`. Dies sind lokale Anmeldeinformationsdateien. Halten Sie sie fern
von Repositories und Backups, die zur Veröffentlichung bestimmt sind.

## Fehlerbehebung

| Nachricht oder Ergebnis | Nächster Schritt |
| - | - |
| Keine Anmeldeinformationen | Konfigurieren Sie die Anmeldeinformationen für den vorgesehenen Kontotyp. |
| Wählen Sie einen Aussteller oder Schlüssel | Geben Sie die in der Konsole angezeigten IDs an; bestätigen Sie, dass der Schlüssel signieren kann. |
| Umgebungs-Mismatch | Test-/Produktionsschlüssel dem richtigen API-Host zuordnen. |
| Verbraucher-Signierschlüssel werden verwaltet | Entfernen Sie nur für den Arbeitsbereich geltende Flags oder verwenden Sie einen Arbeitsbereich-API-Schlüssel. |
| `INCOMPLETE` | Geben Sie den gespeicherten Beleg oder die exakt signierte Nutzlast an; eine ID oder ein Dateihash allein ist für Arbeitsbereichssignaturen nicht ausreichend. |
| `ALTERED` | Vergewissern Sie sich, dass Sie die exakte Originaldatei bereitgestellt haben. |
| Anfragezeitüberschreitung | Überprüfen Sie das Ergebnis des Vorgangs, bevor Sie es erneut versuchen; behalten Sie den ursprünglichen Wiederholungsschlüssel bei. |

Anfragen verwenden ein 30-Sekunden-Timeout und werden einmal gesendet. Weiterleitungen werden abgelehnt. Ratenbegrenzung
verbleibende Werte werden nicht als monatliches Kontingent dargestellt.

## Upgrade von 1.0

Version 1.1.1 fügt beibehaltene signierte Nutzlasten und kryptografische Verifizierung mit Originaldateien hinzu. Version 1.1 behebt API-Schlüssel-Header, Consumer `content_hash`, Arbeitsbereichssignierung, privat
Verbraucher-Standardeinstellungen, JSON-Ausgabe, Befehlsaliase und echte Verifizierung. Vorherige Beispiele
dass eine Schutzprüfung eine kryptografische Verifizierung war, sollte ersetzt werden.

MIT-Lizenz.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.