NAME

chalk - Colorize text for terminal output

VERSION

This document describes version 0.050 of chalk (from Perl distribution App-chalk), released on 2022-09-29.

SYNOPSIS

Usage:

 % chalk [options] <style> ... <string>
 % echo <string> | chalk [options] <style> ...

Example:

 % chalk red bold 'Unicorns & Rainbows'

DESCRIPTION

This is a Perl port of node.js' chalk-cli utility (https://www.npmjs.com/package/chalk-cli). This Perl port is basically the same as the node.js' version, but with a smaller startup overhead.

OPTIONS

--help, -h

Display help message and exit.

-n

Do not output the trailing newline.

FAQ

What are the supported styles?

Modifiers:

    reset
    bold
    dim
    italic (not widely supported)
    underline
    inverse
    hidden
    strikethrough (not widely supported)

Colors:

    black
    red
    green
    yellow
    blue
    magenta
    cyan
    white
    gray

Background colors:

    bgBlack
    bgRed
    bgGreen
    bgYellow
    bgBlue
    bgMagenta
    bgCyan
    bgWhite

What about the library version of chalk?

We already have Term::ANSIColor in Perl. Use that.

ENVIRONMENT

COLOR => bool

Can be set to 0 or 1 to always disable or always enable color.

FORCE_COLOR => bool

Can be set to 1 to always enable color.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-chalk.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-chalk.

SEE ALSO

Term::ANSIColor

https://www.npmjs.com/package/chalk

https://www.npmjs.com/package/chalk-cli

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2015 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-chalk

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

cpanm App::chalk

perl -MCPAN -e shell
install App::chalk