dokumentacja · dla deweloperów

CLI

Panel dla ludzi, którzy wdrażają. Wszystko, co panel robi z banerem, z Twojego terminala lub CI, z plikiem konfiguracyjnym w repozytorium.

Instalacja i logowanie

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

login używa device flow (zatwierdź kod w panelu) i zapisuje token. Opcje: --token, by zapisać istniejący token cc_*, --scopes, by poprosić o konkretne zakresy, --no-open, by wypisać adres zamiast otwierać przeglądarkę. whoami pokazuje token, zakresy i używany workspace; logout usuwa zapisane poświadczenia.

Konfiguracja projektu

npx cookiecrumbs init

init wykrywa framework (Next.js, React, Astro, Nuxt, SvelteKit lub zwykły HTML), tworzy lub łączy stronę, zapisuje cookiecrumbs.config.ts plus pliki tekstów per język i wypisuje właściwy snippet instalacyjny. Opcje: --site <id>, by połączyć istniejącą stronę, --name i --domain, by utworzyć nową, --env preview|production, --format ts|json, --publish, by od razu wysłać, -y, by nadpisać istniejącą konfigurację. link --site <id> łączy istniejący folder później.

Pętla edycji

pull: pobiera zdalny szkic (trójstronnie: nadpisz, zachowaj lub konflikt).
diff: pokazuje, co zmieniłby push, lokalna konfiguracja względem zdalnego szkicu.
push: waliduje, zapisuje szkic i publikuje nową wersję. Opcje: --env, --note, --material (ponownie pyta o zgodę), --dry-run (lint i diff bez zapisu).
status: stan lokalny względem zdalnego połączonej strony. open [page] przeskakuje do panelu.
versions list · show <n> · rollback <n> · promote <n>: opublikowana historia; rollback publikuje kopię, promote przenosi wersję podglądową na produkcję.

Skanowanie, także w CI

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

scan uruchamia hostowany skan połączonej strony. --wait blokuje do zakończenia i wypisuje podsumowanie (z --timeout, domyślnie 30 minut); --fail-on-unknown kończy z kodem 1, gdy znaleziono niesklasyfikowane trackery, a --fail-on-preconsent kończy z kodem 1, gdy cokolwiek załadowało się przed zgodą, co czyni go bramką CI; --sarif <file> zapisuje znaleziska jako SARIF 2.1.0 dla interfejsów skanowania kodu; --states wybiera stany zgody do przejścia (no_interaction,reject_all,accept_all); --pages ogranicza skan.

Sama strona

Wszystko, co mogą zmienić strony Ustawienia, Skany, Usługi, Problemy, Domeny i Instalacja w panelu, z terminala. Każde polecenie przyjmuje --site <id>; bez niego używana jest połączona strona.

sites list · show · create --name --domain [--languages] · update [--name] [--retention <months>] [--public-versions-feed on|off] [--consent-cookie-name] [--reask-months]
schedule pokazuje harmonogram skanów; schedule set --cadence monthly|weekly|daily --pages <n> --states … --start-urls … --include … --exclude … --robots on|off --pause|--resume. Zmieniają się tylko przekazane opcje, a wartość ograniczona przez plan jest raportowana, nie ukrywana.
services list · add <name> --category <key> [--provider] [--domain] [--hosts] [--scripts] [--cookies] [--basis] … · update <id> … · remove <id>: trackery deklarowane przez stronę; przy następnym push trafiają do deklaracji i listy blokowania.
issues list [--status] · suppress <id> --reason "…" · unsuppress <id>: powód jest zachowywany przy problemie i pokazywany w ścieżce audytu.
install status i install check [--url] [--wait]: czy cc.js jest na stronie? Z --wait polecenie kończy z kodem 1, gdy instalacja jest zepsuta, więc działa jako test po deployu.
domains list · verify <id> [--method dns_txt|meta]: wypisuje dokładny rekord lub tag do opublikowania.

Rekordy i dowód

logs export: eksportuje rekordy zgód (podpisany JSONL lub CSV) przez zadanie eksportu.
declaration export: pobiera publiczną listę cookies jako html, md lub json.
export --all: wszystko o połączonej stronie do folderu.

Workspace

tokens list · create · revoke <id>: tokeny API; create uruchamia device flow i wypisuje sekret raz.
alerts list · ack <id> · resolve <id>: skrzynka alertów.
webhooks list · create · rotate · delete i podgląd dostarczeń; usage.
templates list · show <id> · save <name> [--from-site] [--config file.json] [--id] · delete <id> · apply <id>: szablony workspace’u ze szkicu strony lub pliku konfiguracyjnego, stosowane do dowolnej liczby stron.