@c15t/cli: c15t's CLI

CLI for rapid c15t setup. Scaffold React and Next.js cookie banners and a preferences centre, generate types and config, and run migration tooling for self-hosted deployments.

Key Features

• Configuration Generation: Automatically generate schema and code for consent management
• Database Migrations: Simplified database schema updates
• Multi-Framework Support: Works seamlessly across different web frameworks
• Interactive CLI: User-friendly command-line interface with guided workflows
• Agent Skills: Install reusable c15t agent skills for AI tooling
• GitHub Integration: Easy way to star and support the project
• Documentation Access: Quick access to project documentation

Prerequisites

• Node.js 18.17.0 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. Run @c15t/cli setup to create initial configuration
2. Use the docs bundled in installed c15t packages under docs/ for local agent context
3. Customize consent settings in generated files
4. Integrate with your web application
5. Use @c15t/cli self-host migrate for self-hosted database schema updates

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

For further information, guides, and examples visit the reference documentation.

Support

• Join our Discord community
• Open an issue on our GitHub repository
• Visit inth.com and use the chat widget
• Contact our support team via email [email protected]

Contributing

• We're open to all community contributions.
• Read our Contribution Guidelines
• Review our Code of Conduct
• Fork the repository
• Create a new branch for your feature
• Submit a pull request
• All contributions, big or small, are welcome and appreciated.

Security

If you believe you have found a security vulnerability in c15t, we encourage you to responsibly disclose this and NOT open a public issue. We will investigate all legitimate reports.

Our preference is that you make use of GitHub's private vulnerability reporting feature to disclose potential security vulnerabilities in our open-source software. To do this, please visit https://github.com/c15t/c15t/security and click the "Report a vulnerability" button.

Security Policy

• Please do not share security vulnerabilities in public forums, issues, or pull requests
• Provide detailed information about the potential vulnerability
• Allow reasonable time for us to address the issue before any public disclosure
• We are committed to addressing security concerns promptly and transparently

License

Apache License 2.0

Built by Inth