Gathering detailed insights and metrics for cli-highlight
Gathering detailed insights and metrics for cli-highlight
Installations
npm install cli-highlightDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=8.0.0
Node Version
14.15.1
NPM Version
6.14.9
Score
95.5
Supply Chain
96.5
Quality
75
Maintenance
100
Vulnerability
100
License
Releases
16
Languages
10
TypeScript
1C Enterprise
Groovy
Zephir
Hy
XQuery
Scheme
Shell
HTML
JavaScript
TypeScript (72.42%)
1C Enterprise (9.17%)
Groovy (4.93%)
Zephir (3.66%)
Hy (3.4%)
XQuery (2.38%)
Scheme (2.29%)
Shell (0.8%)
HTML (0.59%)
JavaScript (0.36%)
Developer
Download Statistics
Total Downloads
567,425,438
Last Day
198,682
Last Week
3,693,125
Last Month
16,019,458
Last Year
175,845,636
GitHub Statistics
ISC License
319 Stars
112 Commits
30 Forks
7 Watchers
46 Branches
8 Contributors
Updated on Jul 03, 2025
Bundle Size
1.06 MB
Minified
331.21 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
2.1.11
Package Id
cli-highlight@2.1.11
Size
11.79 kB
NPM Version
6.14.9
Node Version
14.15.1
Published on
Mar 28, 2021
Total Downloads
Cumulative downloads
Total Downloads
567,425,438
Last Day
-12.8%
198,682
Compared to previous day
Last Week
-9.5%
3,693,125
Compared to previous week
Last Month
3.8%
16,019,458
Compared to previous month
Last Year
52.8%
175,845,636
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
19
cli-highlight
Syntax highlighting in your terminal
Example
CLI Usage
Output a file
1$ highlight package.json
Color output of another program with piping. Example: A database migration script that logs SQL Queries
1$ db-migrate --dry-run | highlight
Command line options:
1Usage: highlight [options] [file] 2 3Outputs a file or STDIN input with syntax highlighting 4 5Options: 6 --language, -l Set the langugage explicitely 7 If omitted will try to auto-detect 8 --theme, -t Use a theme defined in a JSON file 9 --version, -v Show version number [boolean] 10 --help, -h Show help [boolean]
Programmatic Usage
You can use this module programmatically to highlight logs of your Node app. Example:
1const highlight = require('cli-highlight').highlight 2const Sequelize = require('sequelize') 3 4const db = new Sequelize(process.env.DB, { 5 logging(log) { 6 console.log(highlight(log, {language: 'sql', ignoreIllegals: true})) 7 } 8})
Detailed API documenation can be found here.
Themes
You can write your own theme in a JSON file and pass it with --theme.
The key must be one of the highlight.js CSS class names or "default",
and the value must be one or an array of Chalk styles to be applied to that token.
1{ 2 "keyword": "blue", 3 "built_in": ["cyan", "dim"], 4 "string": "red", 5 "default": "gray" 6}
The style for "default" will be applied to any substrings not handled by highlight.js. The specifics depend on the language but this typically includes things like commas in parameter lists, semicolons at the end of lines, etc.
The theme is combined with the default theme. The default theme is still not colored a lot or optimized for many languages, PRs welcome!
Supported Languages
All languages of highlight.js are supported. Check a CI build for examples of all the different languages and their highlighting.
Contributing
The module is written in TypeScript and can be compiled with npm run build.
npm run watch starts tsc in watch mode. Tests are written with mocha.
Improving language support is done by adding more colors to the tokens in the default theme and writing more tests.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE.txt:0
- Info: FSF or OSI recognized license: ISC License: LICENSE.txt:0
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/felixfbecker/cli-highlight/build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/felixfbecker/cli-highlight/build.yml/main?enable=pin
- Warn: downloadThenRun not pinned by hash: .github/workflows/build.yml:25
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
- Info: 0 out of 1 downloadThenRun dependencies pinned
Reason
Found 2/20 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/build.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 13 are checked with a SAST tool
Reason
70 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4r62-v4vq-hr96
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
3
/10
Last Scanned on 2025-06-30
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