zum Hauptinhalt springen
Dokumentation durchsuchen

syncanix init

Erkennen Sie Ihre API, bauen Sie den Fähigkeitskatalog und laden Sie ihn hoch – mit einwilligungsgebundener KI-Anreicherung.

init ist der Befehl, den Sie am häufigsten ausführen. Er scannt Ihr Projekt, verwandelt Ihre API in einen Fähigkeitskatalog und lädt ihn in Ihren Arbeitsbereich.

npx syncanix init

Optionen

-f, --framework <name>
Erzwingt ein bestimmtes Framework statt der automatischen Erkennung. Akzeptiert jedes von Syncanix unterstützte Framework – zum Beispiel nestjs, express, fastapi, django oder laravel.
--env <env>
Zielt beim Hochladen des Katalogs auf die Umgebung development (Standard) oder production.
--offline
Schreibt den Katalog lokal, ohne ihn hochzuladen.
-y, --yes
Akzeptiert Standardwerte und überspringt Eingabeaufforderungen – die Anreicherung nutzt Ihre lokalen Anbieterschlüssel, wenn sie gesetzt sind, und wird andernfalls übersprungen.
--byok-key <key>
Verwendet Ihren eigenen LLM-Anbieterschlüssel für die Anreicherung statt der Schlüssel in Ihrer Umgebung.
--byok-provider <provider>
Der BYOK-Anbieter – anthropic oder openai. Wird bei Weglassen aus dem Schlüsselformat abgeleitet.
--force
Fährt über die Kostenobergrenze der Anreicherung hinaus fort und akzeptiert die geschätzten Ausgaben.
--reset-consent
Löscht die gespeicherte Anreicherungs-Einwilligung, sodass init erneut fragt.
--init-config
Erzeugt die Start-Dateien .syncanix.yaml und .syncanixignore neu (überschreibt vorhandene Dateien).
--graphql-endpoint <url>
Inspiziert einen laufenden GraphQL-Endpunkt, um code-first-Mutationen zu typisieren.
--telemetry
Aktiviert anonyme Nutzungs-Telemetrie (standardmäßig aus).

Was er tut

  1. Erkennt Ihre FrameworksScannt das Projekt und meldet jedes erkannte Framework – nicht nur das oberste.
  2. Extrahiert FähigkeitenLiest Ihre Routen und baut eine strukturierte Liste von Fähigkeiten mit ihren Eingaben und Nebenwirkungen.
  3. Wendet .syncanixignore anVerwirft alles, was Ihren Ignore-Regeln entspricht, bevor es geschrieben, angereichert oder hochgeladen wird.
  4. Fragt zur KI-AnreicherungZeigt eine Kostenschätzung und fragt, wie Sie vorgehen möchten, bevor Code-Text an einen Anbieter gesendet wird.
  5. Schreibt den KatalogSpeichert eine deterministische .syncanix/catalog.json, die Sie prüfen und versionieren können.
  6. Lädt ihn hochSendet den Katalog an Ihren Arbeitsbereich – außer Sie haben --offline übergeben oder noch keinen API-Schlüssel.

Standardmäßig statisch

Die Erkennung liest Ihren Code; sie führt ihn nie aus, und keine Produktionsdaten verlassen Ihren Rechner. Das Einzige, was gesendet werden kann, ist der strukturierte Katalog – und KI-Anreicherung geschieht nur mit Ihrer ausdrücklichen Einwilligung.

Die KI-Anreicherung verfasst klarere Titel und Beschreibungen für Ihre Fähigkeiten. Bevor etwas gesendet wird, zeigt die CLI genau, was gesendet würde (Fähigkeits-IDs, Methoden und Pfade, Argumentnamen und ein kurzer, von Geheimnissen bereinigter Handler-Auszug) und was nicht (Quelldateien, Ihre Daten, Geheimnisse, alles Ignorierte). Dann wählen Sie einen Modus:

Lokale Schlüssel
Verwendet die Anthropic- und OpenAI-Schlüssel, die bereits in Ihrer lokalen Umgebung vorhanden sind, mit erzwungener Zero-Data-Retention. Die Anreicherung läuft von Ihrem Rechner aus – es gibt keinen von Syncanix gehosteten Anreicherungsdienst.
BYOK
Verwendet Ihren eigenen Anbieterschlüssel; der Handler-Text geht direkt von Ihrem Rechner zum Anbieter, und Syncanix sieht ihn nie.
Überspringen
Keine Anreicherung – liefern Sie nur die Extraktor-Metadaten und reichern Sie später im Dashboard an.

Nächste Schritte