zum Hauptinhalt springen
Dokumentation durchsuchen

Weitere CLI-Befehle

Prüfen, was live ist, Ihre Integration erzeugen, einen Katalog inspizieren und lesen, was Ihr Arbeitsbereich dem Agenten erlaubt — ohne das Dashboard zu öffnen.

Über init hinaus deckt die CLI vier Aufgaben ab: Anmelden und Arbeitsbereich wählen, prüfen was wirklich live ist, Ihre Integration für Sie schreiben, und die Konfiguration Ihres Arbeitsbereichs aus einem Terminal oder CI-Job lesen.

An- und abmelden

Melden Sie sich mit Ihrem Browser an: Die CLI öffnet das Dashboard, Sie bestätigen das Gerät, und eine mit Ihrem Konto verknüpfte Sitzung wird in ~/.syncanix/credentials gespeichert (nur für Sie lesbar) — die CLI handelt dann mit Ihrer Rolle, in Ihren Arbeitsbereichen. Verwenden Sie stattdessen --key für einen Arbeitsbereichs-Maschinenschlüssel (CI; Admin-Genehmigung), prüfen Sie mit syncanix whoami, als wer Sie angemeldet sind, und melden Sie sich mit syncanix logout ab — die Sitzung wird dabei auch serverseitig widerrufen.

npx syncanix login
npx syncanix logout

Prüfen Sie, wer Sie sind und wohin Sie schreiben

Eine Sitzung handelt in Ihrem Namen – derselbe Befehl kann also je nach aktivem Workspace woanders hinschreiben. syncanix whoami beantwortet beides auf einmal: Ihre Identität, den aktiven Workspace und Ihre Rolle darin, wann die Sitzung abläuft und jeden Workspace, in dem Sie handeln können. Die Antwort kommt live vom Server und ist damit zugleich eine Prüfung, ob Ihre Sitzung noch gilt. syncanix workspace list zeigt dieselbe Liste für sich, und syncanix workspace use <slug> ändert, wohin der nächste Befehl schreibt. Führen Sie whoami aus, bevor Sie etwas hochladen.

npx syncanix whoami
npx syncanix workspace list
npx syncanix workspace use acme

Ein Schema importieren

Sie haben bereits ein OpenAPI- oder GraphQL-Schema? Bauen Sie einen Katalog direkt daraus, ohne Code-Scan. Übergeben Sie --offline, um nicht hochzuladen, oder --env, um eine Umgebung anzusteuern.

npx syncanix import --openapi ./openapi.json
npx syncanix import --graphql ./schema.graphql

Ist mein Checkout synchron?

Vergleicht, was ein frischer Scan dieses Checkouts findet, mit dem, was Ihr Arbeitsbereich gerade ausliefert, und zeigt die Differenz. Das ist der Befehl, wenn der Assistent etwas Unerwartetes tut: Er beantwortet „läuft in Produktion, was ich denke?“, ohne dass Sie etwas öffnen müssen.

npx syncanix status

Eine Änderung vor Ihren Kunden bemerken

Vergleicht Ihren Arbeitsbaum mit dem eingecheckten Katalog und endet mit Fehler, wenn sie auseinanderlaufen. In Ihrer Continuous-Integration-Pipeline lässt eine Änderung an etwas, worauf der Assistent baut, den Build scheitern, statt in einem Gespräch aufzutauchen.

npx syncanix drift

Ist das Widget wirklich auf der Seite?

Lädt eine URL und meldet, ob die Syncanix-Einbindung dort aktiv ist. Schneller als einen Browser zu öffnen und nützlich in einem Deploy-Check — der häufigste Grund für fehlenden Chat ist ein Build, der das Script-Tag verloren hat.

npx syncanix embed check https://app.acme.com

Schreib mir die Integrationsdateien

Schreibt einen kleinen Satz Syncanix-Dateien in Ihr Projekt — die Einbindung, die Konfiguration und was Ihr Stack sonst braucht. Es legt nur Dateien an, die fehlen; zweimal ausführen ist also sicher und es kann nie etwas überschreiben, das Sie bearbeitet haben.

npx syncanix generate

Das Widget in ein Frontend einbauen

Eine geführte Fassung derselben Aufgabe für ein bestehendes Frontend, in vier Schritten, die Sie nacheinander ausführen: Es scannt Ihre App, plant die Änderung, zeigt Ihnen den Plan zur Freigabe und wendet ihn erst dann an.

npx syncanix integrate scan
npx syncanix integrate plan
npx syncanix integrate apply

Einen Katalog im Terminal lesen

Listen Sie auf, was eine Katalogdatei enthält — gefiltert nach Risikoklasse, Methode, Framework —, vergleichen Sie zwei davon, oder exportieren Sie einen Compliance-Bericht mit jeder Fähigkeit, ihrem Risiko und dem, was sie berührt. Nützlich im Review, und der Export ist ein Dokument, das Sie weitergeben können.

npx syncanix catalog list --side-effect destructive
npx syncanix catalog diff ./before.json ./after.json
npx syncanix catalog compliance --format md

Derselbe Befehl kann Namen und Beschreibung lesen oder ändern, die dem Agenten für eine Fähigkeit ausgeliefert werden — die klarsprachige Formulierung, die eine freigebende Person sieht. Praktisch, um eine unglückliche Beschreibung ohne Dashboard zu korrigieren.

Lesen, was der Agent darf

Drei Nur-Lese-Befehle für die Fragen eines Audits: jede Fähigkeit mit Aktivierungsstand und Risikoklasse, jede Fähigkeitsänderung, die auf eine zweite Freigabe wartet, und die von Ihrem Arbeitsbereich ausgegebenen API-Schlüssel — nur Präfixe, nie ein Geheimnis.

npx syncanix governance list
npx syncanix approvals
npx syncanix keys list

Lokale Dev-Umgebung

Startet eine lokale Seite, die das Widget gegen ein Entwicklungs-Backend einbettet und bei Katalogänderungen live neu lädt. Optionen legen Port, Backend-Ursprung, Widget-Quelle, veröffentlichbaren Schlüssel und Katalogpfad fest.

npx syncanix dev --port 4321

Ihr Setup diagnostizieren

Prüft Ihre Umgebung auf häufige Probleme – Node-Version, ein erkanntes Framework, eine gültige Konfiguration und einen auflösbaren API-Schlüssel. Bei Problemen endet er mit einem Code ungleich null.

npx syncanix doctor

Einen externen MCP-Server registrieren

Wenn Ihr Arbeitsbereich bereits einen eigenen MCP-Server betreibt, registrieren Sie ihn, damit Syncanix Werkzeugaufrufe an ihn weiterleiten kann. Sie müssen angemeldet sein; die Anmeldeinformation wird sicher gespeichert und nie zurückgegeben.

npx syncanix byomcp register --server-url https://mcp.example.com

Katalog-als-Code-Overlays

Verwalten Sie ein versioniertes syncanix.yaml-Overlay: init erstellt eines, validate prüft es, und apply führt es mit einem erkannten Katalog zusammen.

npx syncanix yaml init
npx syncanix yaml validate
npx syncanix yaml apply --catalog ./.syncanix/catalog.json

Version

Gibt die CLI-, Node- und Build-Versionen aus – praktisch beim Melden eines Problems.

npx syncanix version

Nächste Schritte