Getting Started

This page walks the full loop end-to-end. If you haven't already, skim the Welcome page for the architecture diagram that shows how the pieces fit together.

1. Install the CLI

pnpm add -g @cookiepal-oss/cli

2. Crawl your site

cookiepal crawl https://example.com --max-pages 20

The crawler walks same-origin links (BFS, capped by --max-pages / --max-depth) and writes every cookie it observes to a user-global SQLite file at ~/.config/cookiepal/db.sqlite.

3. Open the dashboard

cookiepal dashboard

Defaults to port 3000 and opens your browser. Use it to:

Assign categories to each cookie.
Edit banner copy, colors, and position.
Add localized strings.

Everything writes back to the same SQLite file.

4. Build the drop-in bundle

cookiepal build

Produces cookiepal.bundle.js at ~/.config/cookiepal/builds/<site-slug>/cookiepal.bundle.js (platform equivalents on macOS/Windows). Override the location with -o ./public/cookiepal.bundle.js if you want it landing straight in your site's assets.

5. Deploy

Drop the bundle into your site's <head>:

<script src="/cookiepal.bundle.js"></script>

The bundle is an IIFE that flattens its namespace to window.cookiepal and calls cookiepal.run(config) with your baked-in config. No module loader required.