Entwicklung

Kommandozeile

Installiere die SubFT-CLI, binde lokale Projekte und führe Untertiteloperationen im Terminal aus.

Schnellstart
pip install subft-cli
subft login
subft project sync /media/library --create
subft operation start /media/library --lang de

Workflow

Von der Anmeldung zur lokalen Ausgabe

Einmal authentifizieren, ein lokales Verzeichnis binden, Remote-Arbeit starten und das Ergebnis lokal anwenden.

  1. 1AnmeldenToken speichern und API-Gateway auswählen.
  2. 2Binden und synchronisierenEin Verzeichnis mit einem Projekt verbinden und Medien abgleichen.
  3. 3Starten und beobachtenOperation erstellen, Fortschritt abwarten oder für später trennen.
  4. 4Ausgabe anwendenFertige Spuren oder eingebettete Ausgaben ins lokale Verzeichnis schreiben.

Referenz

Befehle und Optionen

Dies sind die stabilen, öffentlich nutzbaren Befehlsgruppen. Globale Automatisierungsoptionen können verwendet werden, wo sie unterstützt werden.

Globale Optionen

BefehlOptionenZweck
subft COMMAND[--json] [--yes]

Jeden Befehl mit versionierter JSON-Ausgabe oder deterministischer Bestätigungsbehandlung ausführen.

subft --version

Installierte CLI-Version ausgeben.

subft --help

Referenz des Hauptbefehls anzeigen; jeder Unterbefehl unterstützt ebenfalls --help.

Authentifizierung

BefehlOptionenZweck
subft login[--api-url URL] [--token TOKEN]

Mit einem Token authentifizieren und optional ein anderes Gateway wählen.

subft status[--api-url URL]

Aktuelles Gateway, Identität und Quelle der Anmeldedaten anzeigen.

subft logout

Das von der CLI gespeicherte Token entfernen.

Projekte und Synchronisierung

BefehlOptionenZweck
subft project bind PATH[--project-id ID | --create [--name NAME]] [--api-url URL]

Einen lokalen Pfad an ein bestehendes oder neues Projekt binden.

subft project forget PATH[--project-id ID | --all] [--api-url URL]

Eine oder alle lokalen Projektbindungen entfernen.

subft project bindings[PATH]

Gespeicherte Bindungen auflisten, optional nach Pfad gefiltert.

subft project sync PATH[--preview] [--include-hidden] [--project-id ID | --create [--name NAME]] [--api-url URL]

Deterministische Synchronisierung zwischen lokalem Pfad und Projekt prüfen oder anwenden.

Operationen

BefehlOptionenZweck
subft operation start PATH --lang CODE[--output-target TARGET] [--remove-track] [--wait | --detach] [--include-hidden] [--project-id ID | --create [--name NAME]] [--allow-partial] [--api-url URL]

Eine Untertiteloperation für das gebundene Projekt und die gewählte Sprache starten.

subft operation watch OPERATION_ID[--api-url URL]

Eine Operation bis zu ihrem Endzustand verfolgen.

subft operation apply OPERATION_ID PATH[--output-target TARGET] [--remove-track | --keep-track] [--allow-partial] [--api-url URL]

Eine abgeschlossene Operation herunterladen und auf lokale Dateien anwenden.

Unterstützte CLI-Eingaben

VideoMP4, MKV, AVI, MOV, WEBM
AudioMP3, WAV, FLAC, AAC, OGG, M4A
UntertitelSRT, VTT, ASS
VobSub-PaarIDX + SUB

Ausgabeziele

Wähle eine externe Sidecar-Datei, SubFT-JSON oder eine eingebettete Medienausgabe.

  • external_srt
  • external_vtt
  • external_ass
  • external_csubs_json
  • embedded

Gateway und lokale Konfiguration

Nutze --api-url oder diese Umgebungsvariablen für andere Gateways und Anmeldedaten.

  • SUBFT_API_URL
  • SUBFT_API_TOKEN

Die CLI nutzt diese XDG-Orte und fällt auf die gezeigten Pfade im Home-Verzeichnis zurück. Unter POSIX sind private Berechtigungen erforderlich.

  • $XDG_CONFIG_HOME/subft/config.json~/.config/subft/config.json
  • $XDG_STATE_HOME/subft/projects.json~/.local/state/subft/projects.json

Fehlerbehebung

Häufige Fehler

FFmpeg wird nicht gefundenInstalliere ffmpeg und ffprobe und stelle sicher, dass beide über PATH verfügbar sind.
Authentifizierung ist veraltetFühre status aus und melde dich bei fehlgeschlagener Prüfung erneut mit dem aktiven Token an.
Das Verzeichnis ist nicht gebundenBinde es an ein Projekt oder ergänze --project-id beziehungsweise --create.
Eine Operation endet teilweisePrüfe gemeldete Fehler und nutze --allow-partial nur, wenn Teilergebnisse akzeptabel sind.