@c15t/core

中文文档
3.2.2发布于 2026/11/02Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 22.1万

Headless consent engine behind c15t. Stores consent, decides who sees the banner and gates configured scripts on each visitor's consent policy.

原始使用文档
文档目录12 节
  1. Key Features
  2. Prerequisites
  3. Installation
  4. Usage
  5. Run c15t on Inth
  6. Documentation
  7. Related Packages
  8. Docs for AI Agents
  9. Support
  10. Contributing
  11. Security
  12. License

c15t: the open standard for cookie banners

@c15t/core: Headless JavaScript cookie consent engine

Latest NPM Version Stars License Discord Skills Made by Inth

The headless JavaScript cookie consent engine behind every c15t adapter. It resolves consent policies for GDPR and other privacy laws, stores choices, and holds back configured scripts, iframes, and network requests that the visitor's policy and choices do not allow. Use it to build your own consent UI or to connect a framework that has no c15t adapter.

c15t is used by 2,100+ sites, including expo.dev, zed.dev, unkey.dev, mintlify.com, and sazabi.com.

Key Features

  • Bring your own UI: render from a consent snapshot, and c15t keeps state, storage, and policy resolution
  • Control configured scripts, iframes, and network requests with category permissions from the resolved policy
  • Policies decide who sees a banner: opt-in for visitors in the EU, opt-out for some US states, or rules that you write
  • Google Consent Mode v2, IAB TCF 2.4, and Global Privacy Control support
  • Creating a runtime has no side effects, so the module is safe to import on the server
  • Vendor loaders for Google Tag Manager, Meta Pixel, PostHog, and more through @c15t/integrations

Prerequisites

  • Node.js 20.19 or later
  • An Inth project (free sign-up). For development and tests, local mode needs no backend

Installation

pnpm add @c15t/core

The c15t package ships the same engine at c15t and c15t/runtime, plus every framework adapter.

Usage

  1. Create one runtime for the page with createConsentRuntime and a mode such as hosted()
  2. Call runtime.start() in the browser
  3. Render your banner from runtime.kernel.getSnapshot() and update it from runtime.kernel.subscribe()
  4. Record choices with runtime.kernel.commands.save('all'), save('none'), or an object such as { measurement: true }
  5. For the full walkthrough, see the headless runtime guide
// src/consent-runtime.ts
import { hosted } from '@c15t/core'
import { createConsentRuntime } from '@c15t/core/runtime'

export const runtime = createConsentRuntime({
  mode: hosted({ backendURL: 'https://your-project.inth.app' }),
})

Run c15t on Inth

c15t needs a backend to serve policies and keep consent records. Inth runs it for you. It stores every choice with its region and policy version, audits your live site and pull requests for privacy risk, and on Pro and above keeps each region's consent rules current with managed policy packs. You don't run the consent database, geo lookups, uptime, or upgrades.

Sign-up is free. Run npx @inth/cli c15t to create a project and set up c15t, or create one by hand and copy its backend URL.

For development and tests, local mode keeps choices in the browser and keeps no consent records. Don't ship it to production. Its factory is local(). The old name, offline(), still works and goes away in v4.

Documentation

See the documentation for guides, API reference, and examples.

  • c15t: this engine plus the React, Next.js, Vue, Nuxt, Astro, and TanStack Start adapters in one install
  • @c15t/browser: a stock banner and preference dialog for plain JavaScript and script-tag sites
  • @c15t/integrations: consent-aware analytics, tag manager, pixel, and widget loaders

Docs for AI Agents

This package ships its documentation as Markdown, matched to the installed version. After you install it, point your coding agent at node_modules/@c15t/core/AGENTS.md. It indexes every guide in node_modules/@c15t/core/docs/.

On the web, every page of the c15t docs has a Markdown version, and llms.txt lists them all. Install the c15t agent skills with npx skills add c15t/skills.

Support

Contributing

Security

Do not open a public issue for a security vulnerability. Report it privately through GitHub's vulnerability reporting. We examine every valid report.

  • Do not share the vulnerability in public forums, issues, or pull requests
  • Give the steps to reproduce it and the versions it affects
  • Give us time to release a fix before you disclose it

License

Apache License 2.0


Built by Inth

版本与发布记录

@c15t/core 共发布 20 个版本,首次发布于 2026/09/15;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.2.2latest2026/11/027 天前
3.2.12026/10/319 天前
3.2.02026/10/3010 天前
3.2.0-canary.0canary2026/10/2316 天前
3.1.02026/10/1723 天前
3.1.0-canary.02026/10/1525 天前

其他发布通道:alpha → 3.0.0-alpha.11,canary → 3.2.0-canary.0。

关于 @c15t/core 的常见问题

@c15t/core 是什么?

Headless consent engine behind c15t. Stores consent, decides who sees the banner and gates configured scripts on each visitor's consent policy.

如何安装 @c15t/core?

在项目目录运行 npm install @c15t/core,或使用 pnpm add / yarn add / bun add。

@c15t/core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@c15t/core 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@c15t/core 可以商用吗?

@c15t/core 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@c15t/core 的下载量有多少?

根据 npm 官方下载统计,@c15t/core 在 2026/10/09 – 2026/11/07 这 30 天内被下载 221,246 次,日均约 7,375 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@c15t/core 还在维护吗?

最新版本 3.2.2 发布于 2026/11/02(7 天前);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/09/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。