init
Zweck
Der Befehl init erstellt einen Arbeitsbereich — ein Verzeichnis mit einer swag2mcp.yaml-Konfigurationsdatei und Unterverzeichnissen für Cache, Spezifikationen, Antworten und Auth-Skripte. Dies ist der erste Befehl, der bei der Einrichtung von swag2mcp ausgeführt wird.
Wann verwenden
- Sie richten swag2mcp zum ersten Mal ein
- Sie möchten einen neuen Arbeitsbereich in einem bestimmten Verzeichnis erstellen
- Sie müssen einen beschädigten oder fehlenden Arbeitsbereich neu initialisieren
Syntax
swag2mcp init [path] [flags]Argumente
| Argument | Position | Erforderlich | Beschreibung |
|---|---|---|---|
path | 1 | Nein | Arbeitsbereichsverzeichnis. Wenn nicht angegeben, Standard: ~/.swag2mcp. |
Flags
| Flag | Kurzform | Typ | Standard | Beschreibung |
|---|---|---|---|---|
--interactive | -i | bool | false | Interaktiven TUI-Assistenten ausführen |
--force | -f | bool | false | Bestehende Konfiguration in einem nicht-leeren Verzeichnis überschreiben |
Wie es funktioniert
Nicht-interaktiver Modus (Standard)
Erstellt eine minimale swag2mcp.yaml ohne Specs. Sie bearbeiten die Datei anschließend manuell.
swag2mcp init
# Erstellt ~/.swag2mcp/swag2mcp.yaml
swag2mcp init ./my-project
# Erstellt ./my-project/swag2mcp.yaml
swag2mcp init /absoluter/pfad
# Erstellt /absoluter/pfad/swag2mcp.yamlInteraktiver Modus (-i)
Nicht für den regelmäßigen Gebrauch empfohlen. Dieser Modus ist für Benutzer gedacht, die mit YAML nicht vertraut sind. Das direkte Schreiben der Konfigurationsdatei ist schneller und zuverlässiger.
Startet einen 18-schrittigen TUI-Assistenten, der Sie durch Folgendes führt:
- Auswahl des Arbeitsbereichsverzeichnisses
- Hinzufügen von Specs mit Domain, Titel, Basis-URL
- Konfigurieren von Collections mit Speicherort-URLs
- Einrichten der Authentifizierung (alle 9 Methoden)
- Konfigurieren von HTTP-Client-Einstellungen (Timeout, Proxy, Header usw.)
swag2mcp init -iForce-Modus (--force)
Standardmäßig weigert sich init, in einem nicht-leeren Verzeichnis ausgeführt zu werden. Verwenden Sie --force zum Überschreiben:
swag2mcp init -f
swag2mcp init ./existing-dir -fWas erstellt wird
~/.swag2mcp/
├── swag2mcp.yaml # Konfigurationsdatei
├── cache/ # Heruntergeladene entfernte Spezifikationsdateien
├── specs/ # Lokale Spezifikationsdateien
├── responses/ # Gespeicherte API-Aufrufantworten
└── auth_scripts/ # Authentifizierungsskripte (für ScriptAuth-Typ)Überprüfung nach dem Befehl
ls ~/.swag2mcp/swag2mcp.yaml
# Wenn die Datei existiert, war init erfolgreichNuancen
- Pfadauflösung:
[path]ist ein Arbeitsbereichsverzeichnis, kein Dateipfad. Die CLI hängtswag2mcp.yamlautomatisch an. Auflösungsreihenfolge: expliziter[path]→ aktuelles Verzeichnis (./) →~/.swag2mcp/. - Prüfung auf nicht-leeres Verzeichnis: Ohne
--forcegibtiniteinen Fehler zurück, wenn das Zielverzeichnis existiert und nicht leer ist. Dies verhindert versehentliches Überschreiben. - Auth-Skript-Stubs: Wenn eine Spec
ScriptAuthverwendet, erstelltinitStub-Skriptdateien (.shunter Unix,.batunter Windows) inauth_scripts/. - Ausgabe: Bei Erfolg wird der Konfigurationspfad und ein Hinweis ausgegeben:
"Nächster Schritt: swag2mcp.yaml bearbeiten oder 'swag2mcp ls' ausführen, um konfigurierte Specs aufzulisten".