@carbon/cli

Task automation for working with the Carbon Design System

Getting started

To install @carbon/cli in your project, you will need to run the following command using npm:

npm install -S @carbon/cli

If you prefer Yarn, use the following command instead:

yarn add @carbon/cli

Usage

You can install @carbon/cli in your project, or use a tool like npx by running the following command in your project:

npx @carbon/cli --help

The output of the --help option is:

Usage: @carbon/cli [options]

Commands:
  cli ci-check              run CI checks
  cli contribute <command>  get started contributing with Carbon
  cli publish <tag>         publish packages that have different versions from
                            the package registry
  cli release [bump]        run the release step for the given version bump
  cli sync [target]         sync files across workspaces

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀

📝 License

Licensed under the Apache 2.0 License.

IBM Telemetry

This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency you are agreeing to telemetry collection. To opt out, see Opting out of IBM Telemetry data collection. For more information on the data being collected, please see the IBM Telemetry documentation.