docs · pour les développeurs

La CLI

Le tableau de bord pour ceux qui livrent. Tout ce que le tableau de bord fait à une bannière, depuis votre terminal ou votre CI, avec un fichier de config dans votre dépôt.

Installer et se connecter

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

login utilise le flux d’appareil (approuvez le code dans le tableau de bord) et stocke un jeton. Options : --token pour stocker un jeton cc_* existant, --scopes pour demander des portées précises, --no-open pour afficher l’URL au lieu d’ouvrir un navigateur. whoami montre le jeton, les portées et l’espace de travail utilisés ; logout supprime les identifiants stockés.

Configurer un projet

npx cookiecrumbs init

init détecte votre framework (Next.js, React, Astro, Nuxt, SvelteKit ou HTML brut), crée ou relie un site, écrit cookiecrumbs.config.ts plus des fichiers de textes par langue, et affiche le bon snippet d’installation. Options : --site <id> pour relier un site existant, --name et --domain pour en créer un nouveau, --env preview|production, --format ts|json, --publish pour pousser tout de suite, -y pour écraser une config existante. link --site <id> relie un dossier existant plus tard.

La boucle d’édition

pull : récupère le brouillon distant (trois voies : écraser, conserver ou conflit).
diff : montre ce que push changerait, config locale contre brouillon distant.
push : valide, enregistre le brouillon et publie une nouvelle version. Options : --env, --note, --material (redemande le consentement), --dry-run (lint et diff sans écrire).
status : état local contre distant du site relié. open [page] saute au tableau de bord.
versions list · show <n> · rollback <n> · promote <n> : l’historique publié ; rollback publie une copie, promote passe une version de prévisualisation en production.

Scanner, et scanner en CI

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

scan lance un scan hébergé du site relié. --wait bloque jusqu’à la fin et affiche le résumé (avec --timeout, 30 minutes par défaut) ; --fail-on-unknown sort avec 1 quand des traceurs non classés ont été trouvés et --fail-on-preconsent sort avec 1 quand quelque chose a chargé avant le consentement, ce qui en fait une barrière CI ; --sarif <file> écrit les résultats en SARIF 2.1.0 pour les interfaces d’analyse de code ; --states choisit les états de consentement à parcourir (no_interaction,reject_all,accept_all) ; --pages plafonne le parcours.

Le site lui-même

Tout ce que les pages Paramètres, Scans, Services, Problèmes, Domaines et Installation du tableau de bord peuvent changer, depuis le terminal. Chaque commande accepte --site <id> ; sans lui, le site relié est utilisé.

sites list · show · create --name --domain [--languages] · update [--name] [--retention <months>] [--public-versions-feed on|off] [--consent-cookie-name] [--reask-months]
schedule montre le planning de scan ; schedule set --cadence monthly|weekly|daily --pages <n> --states … --start-urls … --include … --exclude … --robots on|off --pause|--resume. Seules les options passées changent, et une valeur plafonnée par l’offre est signalée plutôt que cachée.
services list · add <name> --category <key> [--provider] [--domain] [--hosts] [--scripts] [--cookies] [--basis] … · update <id> … · remove <id> : les traceurs que le site déclare ; ils rejoignent la déclaration et la liste de blocage au prochain push.
issues list [--status] · suppress <id> --reason "…" · unsuppress <id> : la raison est conservée avec le problème et affichée dans la piste d’audit.
install status et install check [--url] [--wait] : cc.js est-il sur la page ? Avec --wait, la commande sort avec 1 quand l’installation est cassée, ce qui en fait une vérification post-déploiement.
domains list · verify <id> [--method dns_txt|meta] : affiche l’enregistrement ou la balise exacts à publier.

Enregistrements et preuve

logs export : exporte les preuves de consentement (JSONL ou CSV signé) via une tâche d’export.
declaration export : télécharge la liste publique des cookies en html, md ou json.
export --all : tout ce qui concerne le site relié dans un dossier.

Espace de travail

tokens list · create · revoke <id> : jetons API ; create lance le flux d’appareil et affiche le secret une fois.
alerts list · ack <id> · resolve <id> : la boîte de réception des alertes.
webhooks list · create · rotate · delete et inspection des livraisons ; usage.
templates list · show <id> · save <name> [--from-site] [--config file.json] [--id] · delete <id> · apply <id> : modèles d’espace de travail issus du brouillon d’un site ou d’un fichier de config, appliqués à autant de sites que voulu.