CLI-Referenz
Die kotao-CLI kommt als Dev-Dependency (@kotao/cli) mit deinem Theme. Rufe sie im Projekt
als bun x kotao auf, damit die lokale Installation aufgelöst wird.
Authentifizierung
Abschnitt betitelt „Authentifizierung“kotao auth login
Abschnitt betitelt „kotao auth login“Anmeldung für interaktive CLI-Publishes. Mit --device läuft der OAuth-Device-Flow: Die CLI
zeigt eine URL, du bestätigst im Browser (innerhalb von ~10 Minuten), die Session landet
global in ~/.config/kotao/cli-session.json.
| Flag | Zweck |
|---|---|
--device |
OAuth-Device-Authorization-Flow (empfohlen) |
--no-open |
Browser beim Device-Login nicht automatisch öffnen |
--token <jwt> |
Bereits ausgestelltes API-Bearer-Token speichern |
--accounts-token <token> |
Accounts-Session-Token für Workspace-Wechsel speichern |
kotao auth status / kotao auth logout
Abschnitt betitelt „kotao auth status / kotao auth logout“Gespeichertes Session-Ziel anzeigen bzw. die Session entfernen.
kotao workspace select [workspace-id]
Abschnitt betitelt „kotao workspace select [workspace-id]“Aktiven Workspace fürs CLI-Publishing wählen. Ohne Id interaktiv; die Wahl wird gemerkt.
kotao storefront select [site-id]
Abschnitt betitelt „kotao storefront select [site-id]“Die Ziel-Storefront-Site für Publishes wählen. Gemerkt, bis du neu wählst.
Die Storefront-Toolchain
Abschnitt betitelt „Die Storefront-Toolchain“kotao storefront create <directory>
Abschnitt betitelt „kotao storefront create <directory>“Neues Theme aufsetzen (bun create kotao-storefront ruft das für dich auf). Verbindungs-Flags
(--shop-id, --site-id, --storefront-api-endpoint, --storefront-api-token, …) füllen
.dev.vars vor; --yes läuft nicht-interaktiv.
kotao storefront dev / build / preview
Abschnitt betitelt „kotao storefront dev / build / preview“Lokaler Dev-Server mit Untrusted-Mode-Parität (dev), produktionsgleicher Build
(build) und ein lokaler Server für den Build-Output (preview). --port <n>, wo sinnvoll.
kotao storefront codegen
Abschnitt betitelt „kotao storefront codegen“Typisiertes GraphQL aus deinen #graphql-Dokumenten generieren.
| Flag | Zweck |
|---|---|
--schema-url <url> |
Laufende Storefront-API introspizieren (Default: $STOREFRONT_API_ENDPOINT) |
--schema <file> |
SDL aus einer Datei lesen (offline) |
--documents <dir> |
Verzeichnis für #graphql-Dokumente (Default: app) |
--out <file> |
Output (Default: app/graphql/storefrontapi.generated.d.ts) |
kotao storefront publish
Abschnitt betitelt „kotao storefront publish“Deinen committeten Theme-Quellcode paketieren und über die Workspace-API auf die gewählte
Site publishen. Braucht ein Git-Repository mit committetem bun.lock und kotao.theme.json.
| Flag | Zweck |
|---|---|
--site-id <uuid> |
Ziel-Site (Default: die gewählte / $KOTAO_SITE_ID) |
--deployment-id <id> |
Unveränderliche Deployment-Id (Default: generierte UUID) |
--token <token> |
Workspace-API-Key (Default: $KOTAO_API_TOKEN) |
kotao storefront deploy
Abschnitt betitelt „kotao storefront deploy“Die CI-/Build-Service-Variante von publish: übergibt den Quellcode direkt an einen Build-Service
via --build-service-url / --shop-id / --token (oder die $KOTAO_*-Env-Variablen).
kotao storefront migrate shopify-theme <directory>
Abschnitt betitelt „kotao storefront migrate shopify-theme <directory>“Einen Shopify-Liquid- oder Hydrogen-Theme-Export für die Kotao-Migration auditieren; --json
für maschinenlesbaren Output, --out <dir> für einen Migrations-Entwurf.