1 | # Heroku CLI Color
|
2 |
|
3 | heroku-cli-color`` is a command-line interface (CLI) tool for Heroku, a cloud platform for building, deploying, and managing applications. The project provides custom color options for the Heroku CLI using the chalk module.
|
4 |
|
5 | ## Installation
|
6 |
|
7 | 1. Clone the repository: `git clone https://github.com/heroku/heroku-cli-color.git`
|
8 | 2. Install dependencies: `yarn install`
|
9 | 3. Build the project: `yarn build`
|
10 |
|
11 | ## Usage
|
12 |
|
13 | 1. See example below
|
14 |
|
15 | ## Contributing
|
16 |
|
17 | Contributions are welcome! Please follow these steps:
|
18 |
|
19 | 1. Fork the repository
|
20 | 2. Create a new branch: `git checkout -b my-branch-name`
|
21 | 3. Make your changes and commit them: `git commit -am 'Add some feature'`
|
22 | 4. Push to the branch: `git push origin my-branch-name`
|
23 | 5. Submit a pull request
|
24 |
|
25 | ## Example
|
26 | ```
|
27 | import { color } from './color';
|
28 |
|
29 | console.log(color.attachment('This text is in cyan.'));
|
30 | console.log(color.addon('This text is in yellow.'));
|
31 | console.log(color.configVar('This text is in green.'));
|
32 | console.log(color.release('This text is in blue and bold.'));
|
33 | console.log(color.cmd('This text is in cyan and bold.'));
|
34 | console.log(color.pipeline('This text is in green and bold.'));
|
35 | console.log(color.app('This text is in magenta and prefixed with "⬢".'));
|
36 | console.log(color.heroku('This text is in magenta.'));
|
37 |
|
38 | const coloredText = color.app('My App');
|
39 | console.log(`Welcome to ${coloredText}!`);
|
40 | ```
|