@cloakprotect/prerender

Build-time hook for Cloak-protected sites. Processes your static HTML output during deploy so the first visitor — human or scraper — sees protected content from the first byte.

Pairs with @cloakprotect/next for App Router pages with dynamic per-request data.

Install

npm install --save-dev @cloakprotect/prerender

Dev-only — never ships in your runtime bundle.

Usage

Next.js

next build && cloak-prerender ./.next

Any static framework (Astro, 11ty, Hugo, raw HTML, etc.)

cloak-prerender ./dist
cloak-prerender ./out

Set CLOAK_API_KEY in env, or pass --api-key.

Preview before deploy

cloak-prerender ./dist --dry-run --verbose

CLI reference

| Flag | Default | Description | |---|---|---| | <dir> | required | Build output directory to process. | | --api-url <url> | https://api.cloakprotect.org | Cloak API base URL. | | --api-key <key> | $CLOAK_API_KEY | Cloak API key. Required. | | --seo-mode <mode> | seo-friendly | seo-friendly keeps a short lead readable for search engines; private keeps everything protected. | | --lead-chars <n> | 155 | Chars of leading text exposed in meta description when --seo-mode seo-friendly. | | --dry-run | false | Walk files and report what would change. | | --verbose | false | Log every file visited. |

Framework support

• Next.js App Router — GA
• Next.js Pages Router — GA
• Generic static HTML — GA
• Nuxt 3 — Beta
• SvelteKit — Beta
• Astro, Remix — Generic HTML works today; framework-specific adapters in progress.

SEO

Cloak is designed to be transparent to Google. The default seo-friendly mode keeps a short lead readable for search engines and emits the isAccessibleForFree: false + hasPart JSON-LD pattern that Google documents for paywalled content. Use --seo-mode private to keep everything protected at the cost of search visibility.

License

UNLICENSED — for use only on sites authorized by Cloak. Visit cloakprotect.org.