1 | # @carbon/cli
|
2 |
|
3 | > Task automation for working with the Carbon Design System
|
4 |
|
5 | ## Getting started
|
6 |
|
7 | To install `@carbon/cli` in your project, you will need to run the following
|
8 | command using [npm](https://www.npmjs.com/):
|
9 |
|
10 | ```bash
|
11 | npm install -S @carbon/cli
|
12 | ```
|
13 |
|
14 | If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
|
15 | instead:
|
16 |
|
17 | ```bash
|
18 | yarn add @carbon/cli
|
19 | ```
|
20 |
|
21 | ## Usage
|
22 |
|
23 | You can install `@carbon/cli` in your project, or use a tool like
|
24 | [`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b)
|
25 | by running the following command in your project:
|
26 |
|
27 | ```bash
|
28 | npx @carbon/cli --help
|
29 | ```
|
30 |
|
31 | The output of the `--help` option is:
|
32 |
|
33 | ```bash
|
34 | Usage: @carbon/cli [options]
|
35 |
|
36 | Commands:
|
37 | cli ci-check run CI checks
|
38 | cli contribute <command> get started contributing with Carbon
|
39 | cli publish <tag> publish packages that have different versions from
|
40 | the package registry
|
41 | cli release [bump] run the release step for the given version bump
|
42 | cli sync [target] sync files across workspaces
|
43 |
|
44 | Options:
|
45 | --help Show help [boolean]
|
46 | --version Show version number [boolean]
|
47 | ```
|
48 |
|
49 | ## 🙌 Contributing
|
50 |
|
51 | We're always looking for contributors to help us fix bugs, build new features,
|
52 | or help us improve the project documentation. If you're interested, definitely
|
53 | check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀
|
54 |
|
55 | ## 📝 License
|
56 |
|
57 | Licensed under the [Apache 2.0 License](/LICENSE).
|