@c15t/cli

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

Setup CLI for c15t. Scaffolds the banner for React, Next.js and other frameworks, configures hosted, self-hosted or offline mode, and adds integrations.

原始使用文档
文档目录13 节
  1. Key Features
  2. Prerequisites
  3. Quick Start
  4. Usage
  5. Available Commands
  6. Global Flags
  7. Telemetry
  8. Documentation
  9. Setup Paths
  10. Support
  11. Contributing
  12. Security
  13. License

c15t: the open standard for cookie banners

@c15t/cli: Cookie consent setup CLI

Latest NPM Version Stars License Discord Skills Made by Inth

Set up a c15t cookie consent banner for React, Next.js, and other supported frameworks, preview file edits, and configure consent integrations. Choose a hosted backend, a self-hosted backend, or local mode for development and tests.

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

Key Features

  • V3 quickstart files for Next.js, Nuxt, TanStack Start, Astro, React, JavaScript, a script tag, Vue, Svelte, SvelteKit, and Solid
  • Preview and apply integration files with explicit framework wiring instructions
  • Use prepared local package snapshots before v3 is published
  • Add consent-aware script integration examples
  • Manage hosted authentication and projects, or plan self-hosted database migrations
  • Structured JSON results and a reusable command runner for automation
  • Explicit legacy v1-to-v2 codemods with dry runs
  • Agent skill installation

Prerequisites

  • Node.js 20.19 or later
  • npm, pnpm, or yarn package manager

Quick Start

Easiest setup with @c15t/cli:

# Set up c15t in your project
pnpm dlx @c15t/cli setup
# Alternatives:
# npx @c15t/cli setup
# bunx --bun @c15t/cli setup

The CLI will:

  • Install necessary packages
  • Configure your c15t instance
  • Set up environment variables
  • Add consent management components to your app

Usage

  1. Build the CLI from the checkout with bun run --cwd packages/cli build
  2. Preview unpublished v3 boilerplate: node packages/cli/dist/bin.mjs generate offline --framework react --cwd /path/to/app --plan --json
  3. Repeat with --apply to create files, then follow the generated README to connect them to your application
  4. Use --package-source with prepared local snapshots to avoid fetching unpublished v3 packages

Available Commands

  • setup: Set up c15t in your project
  • codemods: Run migration codemods for c15t upgrades
  • self-host: Self-hosted workflow commands (currently database migrations)
  • skills: Install c15t agent skills for AI-assisted development
  • changelog: Open the c15t changelog in your browser
  • github: Open the project's GitHub repository to star the project
  • docs: Open the c15t documentation in your browser

Global Flags

  • --help: Display help menu
  • --version: Show CLI version
  • --no-telemetry: Disable anonymous usage data collection

Telemetry

Anonymous usage data collection to help improve the CLI

  • Not personally identifiable
  • Used to prioritize features and improvements
  • Completely optional

Disable telemetry by:

  • Use the --no-telemetry flag
  • Set C15T_TELEMETRY_DISABLED=1 in your environment

Documentation

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

Setup Paths

  • Hosted on inth.com: Configure a hosted c15t instance
  • Self-hosted backend: Generate config and run database migrations for @c15t/backend
  • Local mode: Generate a browser-only setup for development and tests. c15t keeps no server-side record of consent

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/cli 共发布 139 个版本,首次发布于 2025/03/12;过去 12 个月发布了 61 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

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

其他发布通道:rc → 2.0.0-rc.11,alpha → 3.0.0-alpha.12,canary → 3.2.0-canary.0,v1-legacy → 1.9.0。

关于 @c15t/cli 的常见问题

@c15t/cli 是什么?

Setup CLI for c15t. Scaffolds the banner for React, Next.js and other frameworks, configures hosted, self-hosted or offline mode, and adds integrations.

如何安装 @c15t/cli?

在项目目录运行 npm install @c15t/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cli、c15t,可以用 npx cli 直接运行。

@c15t/cli 支持 TypeScript 吗?

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

@c15t/cli 支持 ESM 还是 CommonJS?

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

@c15t/cli 可以商用吗?

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

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

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

@c15t/cli 还在维护吗?

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