zum Hauptinhalt springen
Dokumentation durchsuchen

Die Syncanix-CLI

Der optionale tiefere Durchgang: Quellcode für exakte Argument-Schemata lesen und den Katalog auf der Kommandozeile verwalten. Ohne Installation.

Sie brauchen die CLI nicht, um zu starten. Das Widget erkennt Ihr Produkt anhand der Seiten selbst, und das allein ergibt bereits einen funktionierenden Katalog. Die CLI ist der tiefere Durchgang: Sie liest Ihren Quellcode und kann dem Agenten so exakte Argumentnamen und -typen geben, die ein Blick auf den Bildschirm nicht zeigt — und sie verwaltet Ihren Katalog auf der Kommandozeile. Nichts zu installieren; führen Sie sie mit npx aus.

Installation

Führen Sie die CLI direkt aus npm mit npx aus – keine globale Installation nötig:

npx syncanix@latest init

Node.js 20 oder neuer ist erforderlich.

Befehle

init
Scannt Ihren Code, baut den Fähigkeitskatalog und lädt ihn hoch.
console
Öffnet die interaktive Konsole — dasselbe, was ein bloßes `syncanix` in einem Terminal bewirkt.
generate
Schreibt das Integrationskit syncanix/ in Ihr Projekt und legt dabei nur neue Dateien an.
integrate
Erkennt Ihr Frontend und installiert das Widget für Sie — eine freigegebene Datei nach der anderen.
status
Vergleicht diese Arbeitskopie mit dem, was Ihr Arbeitsbereich tatsächlich ausliefert.
import
Baut einen Katalog aus einem vorhandenen OpenAPI- oder GraphQL-Schema.
login / logout
Mit dem Browser anmelden (oder --key für CI) — oder wieder abmelden.
whoami
Zeigt, als wer Sie angemeldet sind und in welchem Arbeitsbereich.
workspace list / use
Listet Ihre Arbeitsbereiche auf oder legt den Standard fest.
dev
Startet eine lokale Umgebung, die das Widget gegen ein Dev-Backend einbettet.
doctor
Prüft Ihre Umgebung und Konfiguration auf häufige Probleme.
byomcp register
Registriert einen externen MCP-Server, den Ihr Arbeitsbereich bereits betreibt.
yaml
Erstellt, prüft und wendet eine Katalog-als-Code-Overlay an.
version
Gibt die CLI-, Node- und Build-Versionen aus.

Globale Optionen

-v, --version
Gibt die CLI-Version aus und beendet sich.
--no-color
Deaktiviert farbige Ausgabe.
--locale <code>
Legt die Ausgabesprache fest: en, es, fr, de, ar oder he.

Nächste Schritte