UNPKG

1.38 kBMarkdownView Raw
1# Heroku CLI Color
2
3heroku-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
71. Clone the repository: `git clone https://github.com/heroku/heroku-cli-color.git`
82. Install dependencies: `yarn install`
93. Build the project: `yarn build`
10
11## Usage
12
131. See example below
14
15## Contributing
16
17Contributions are welcome! Please follow these steps:
18
191. Fork the repository
202. Create a new branch: `git checkout -b my-branch-name`
213. Make your changes and commit them: `git commit -am 'Add some feature'`
224. Push to the branch: `git push origin my-branch-name`
235. Submit a pull request
24
25## Example
26```
27import { color } from './color';
28
29console.log(color.attachment('This text is in cyan.'));
30console.log(color.addon('This text is in yellow.'));
31console.log(color.configVar('This text is in green.'));
32console.log(color.release('This text is in blue and bold.'));
33console.log(color.cmd('This text is in cyan and bold.'));
34console.log(color.pipeline('This text is in green and bold.'));
35console.log(color.app('This text is in magenta and prefixed with "⬢".'));
36console.log(color.heroku('This text is in magenta.'));
37
38const coloredText = color.app('My App');
39console.log(`Welcome to ${coloredText}!`);
40```