Installations

npm install colors-cli

Pull Requests

Open

0

Total

4

Closed

1

Merged

3

Issues

Open

2

Total

5

Closed

3

Releases

9

v1.0.33

Published on 27 Nov 2023

v1.0.32

Published on 09 Mar 2023

v1.0.31

Published on 07 Mar 2023

v1.0.30

Published on 07 Mar 2023

v1.0.29

Published on 15 Dec 2022

v1.0.28

Published on 11 Sept 2021

View all 9 releases

Developer

jaywcjlove

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

No

Node Version

18.18.2

NPM Version

9.8.1 Statistics

76 Stars

127 Commits

14 Forks

3 Watching

2 Branches

4 Contributors

Updated on 22 Aug 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

7,162,869

Last day

-7.8%

11,655

Compared to previous day

Last week

-1.7%

61,999

Compared to previous week

Last month

5.4%

282,401

Compared to previous month

Last year

36.2%

2,871,420

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

Versions

colors-cli

Terminal string styling done right. ಠ_ಠ

Install with npm:

1npm install colors-cli --save-dev

Styles

bold、 faint、 italic、 underline、 blink、 overline、 inverse、 conceal、 strike、

Colors

Foreground	Background	Bright Foreground	Bright Background
black	black_b	black_bt	black_bbt
red	red_b	red_bt	red_bbt
green	green_b	green_bt	green_bbt
yellow	yellow_b	yellow_bt	yellow_bbt
blue	blue_b	blue_bt	blue_bbt
magenta	magenta_b	magenta_bt	magenta_bbt
cyan	cyan_b	cyan_bt	cyan_bbt
white	white_b	white_bt	white_bbt

Basic usage:

Output colored text:

1var color = require('colors-cli')
2console.log( color.red('hello') )

Best way is to predefine needed stylings and then use it:

1var color = require('colors-cli/safe')
2var error = color.red.bold;
3var warn = color.yellow;
4var notice = color.blue;
5console.log(error('Error!'));
6console.log(warn('Warning'));
7console.log(notice('Notice'));

Styles can be mixed:

1var color = require('colors-cli/safe')
2console.log('=>', color.red.bold.underline('hello') )
3console.log('=>', color.magenta_bt.underline('hello ' + color.blue_bt('wo' + color.yellow_bt.magenta_bbt('r') + 'ld') + ' !!!!'));
4console.log('=>', color.magenta_bt.underline('hello ' + color.blue_bt('wo' + color.yellow_bt.magenta_bbt('r'))));
5console.log('=>', color.magenta_bt.underline('hello ' + color.blue_bt('world') + ' !!!!' + color.yellow('kenny') + ' wong' ));
6
7var color = require('colors-cli/safe')
8require('colors-cli/toxic')
9console.log('=> ' + color.underline('$ ' + 'npm'.magenta.underline + ' install'.yellow.underline + ' colors-cli --save-dev'));

1require('colors-cli/toxic')
2console.log( 'hello'.green );
3console.log( 'hello'.green.black_b.underline );
4console.log('=> $'.green + ' npm '.magenta + 'install '.yellow + 'colors-cli'.cyan + ' --save-dev');

ANSI 256 colors

Support ANSI 256 colors. [0 - 255], The rules of method name.

Foreground x32
Background xb32

1var color = require('colors-cli/safe')
2console.log( color.x45.bold.underline('hello') )
3
4require('colors-cli/toxic')
5console.log( 'hello'.x23.underline );
6console.log( 'hello'.green.xb34.underline );

Use the command line

1 Usage: colors
2
3 Options:
4
5   --black  => black
6   --black_b  => black_b
7   --red  => red
8   ...
9
10 Examples:
11
12   colors --red "\nhello world" --bold,underline,yellow "wcj"
13   colors --green,bold "\nhello world"
14   colors --x12,bold "hello world"

Reference

The ANSI Escape sequences control code screen.

1echo -e "\033[31;41;4m something here 33[0m"

\033 As the escape character, inform the terminal to switch to the escape mode.
[ The beginning of the CSI.
m Make the action to be performed.
; ASCII code separator.

License

Licensed under the MIT License.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

Score

4.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More