CookieCrumbs
Kostenlos starten

Docs · für Entwickler

Die CLI

Das Dashboard für Menschen, die liefern. Alles, was das Dashboard mit einem Banner macht, aus Ihrem Terminal oder Ihrer CI, mit einer Konfigurationsdatei in Ihrem Repository.

Installieren und anmelden

npm i -D cookiecrumbs     # or run everything with npx
npx cookiecrumbs login    # device flow: approve in the dashboard

login nutzt den Device-Flow (Code im Dashboard bestätigen) und speichert ein Token. Optionen: --token, um ein bestehendes cc_*-Token zu speichern, --scopes, um bestimmte Scopes anzufordern, --no-open, um die URL auszugeben statt einen Browser zu öffnen. whoami zeigt Token, Scopes und genutzten Workspace; logout entfernt die gespeicherten Zugangsdaten.

Ein Projekt einrichten

npx cookiecrumbs init

init erkennt Ihr Framework (Next.js, React, Astro, Nuxt, SvelteKit oder reines HTML), erstellt oder verknüpft eine Website, schreibt cookiecrumbs.config.ts plus Textdateien pro Sprache und gibt das passende Installations-Snippet aus. Optionen: --site <id>, um eine bestehende Website zu verknüpfen, --name und --domain, um eine neue anzulegen, --env preview|production, --format ts|json, --publish, um sofort zu pushen, -y, um eine bestehende Konfiguration zu überschreiben. link --site <id> verbindet einen bestehenden Ordner später.

Der Bearbeitungszyklus

  • pull: den entfernten Entwurf holen (Drei-Wege: überschreiben, behalten oder Konflikt).
  • diff: zeigen, was push ändern würde, lokale Konfiguration gegen den entfernten Entwurf.
  • push: validieren, den Entwurf speichern und eine neue Version veröffentlichen. Optionen: --env, --note, --material (fragt erneut um Einwilligung), --dry-run (Lint und Diff ohne zu schreiben).
  • status: lokaler gegen entfernter Zustand der verknüpften Website. open [page] springt ins Dashboard.
  • versions list · show <n> · rollback <n> · promote <n>: die veröffentlichte Historie; rollback veröffentlicht eine Kopie, promote hebt eine Preview-Version auf Produktion.

Scannen, und Scannen in CI

npx cookiecrumbs scan --wait --fail-on-unknown --fail-on-preconsent --sarif findings.sarif

scan startet einen gehosteten Scan der verknüpften Website. --wait blockiert bis zum Ende und gibt die Zusammenfassung aus (mit --timeout, Standard 30 Minuten); --fail-on-unknown beendet mit 1, wenn unklassifizierte Tracker gefunden wurden, und --fail-on-preconsent beendet mit 1, wenn etwas vor der Einwilligung geladen hat, was es zum CI-Gate macht; --sarif <file> schreibt Funde als SARIF 2.1.0 für Code-Scanning-Oberflächen; --states wählt die zu crawlenden Einwilligungszustände (no_interaction,reject_all,accept_all); --pages begrenzt den Crawl.

Die Website selbst

Alles, was die Dashboard-Seiten Einstellungen, Scans, Dienste, Probleme, Domains und Installation ändern können, aus dem Terminal. Jeder Befehl nimmt --site <id>; ohne Angabe wird die verknüpfte Website genutzt.

  • sites list · show · create --name --domain [--languages] · update [--name] [--retention <months>] [--public-versions-feed on|off] [--consent-cookie-name] [--reask-months]
  • schedule zeigt den Scan-Zeitplan; schedule set --cadence monthly|weekly|daily --pages <n> --states … --start-urls … --include … --exclude … --robots on|off --pause|--resume. Nur die übergebenen Optionen ändern sich, und ein vom Tarif gekappter Wert wird gemeldet statt versteckt.
  • services list · add <name> --category <key> [--provider] [--domain] [--hosts] [--scripts] [--cookies] [--basis] … · update <id> … · remove <id>: die Tracker, die die Website deklariert; sie kommen beim nächsten push in die Erklärung und die Blockliste.
  • issues list [--status] · suppress <id> --reason "…" · unsuppress <id>: die Begründung bleibt beim Problem und erscheint im Audit-Trail.
  • install status und install check [--url] [--wait]: Ist cc.js auf der Seite? Mit --wait beendet der Befehl mit 1, wenn die Installation defekt ist, und eignet sich so als Post-Deploy-Check.
  • domains list · verify <id> [--method dns_txt|meta]: gibt genau den Eintrag oder das Tag aus, das zu veröffentlichen ist.

Datensätze und Nachweis

  • logs export: Einwilligungsdatensätze exportieren (signiertes JSONL oder CSV) über einen Export-Job.
  • declaration export: die öffentliche Cookie-Liste als html, md oder json herunterladen.
  • export --all: alles zur verknüpften Website in einen Ordner.

Workspace

  • tokens list · create · revoke <id>: API-Tokens; create führt den Device-Flow aus und gibt das Geheimnis einmal aus.
  • alerts list · ack <id> · resolve <id>: der Alarm-Posteingang.
  • webhooks list · create · rotate · delete und Zustellungsprüfung; usage.
  • templates list · show <id> · save <name> [--from-site] [--config file.json] [--id] · delete <id> · apply <id>: Workspace-Vorlagen aus dem Entwurf einer Website oder einer Konfigurationsdatei, anwendbar auf beliebig viele Websites.