ColorizeInstallation
Installation
How to install and set up @visulima/colorize in your project.
Last updated:
Installation
Package Manager
Install @visulima/colorize using your preferred package manager:
npm install @visulima/colorizeRequirements
- Node.js: 22.13 or higher
- TypeScript: 5.0+ (optional, for TypeScript projects)
Import Methods
Node.js (ESM)
// Default import
import colorize from "@visulima/colorize";
// Named imports (recommended)
import { red, green, blue, bold, hex } from "@visulima/colorize";Node.js (CommonJS)
// Default import
const colorize = require("@visulima/colorize");
// Named imports
const { red, green, blue, bold, hex } = require("@visulima/colorize");Browser
For browser environments, use the dedicated browser export:
// ESM default import
import colorize from "@visulima/colorize/browser";
// ESM named imports
import { red, green, blue } from "@visulima/colorize/browser";Important: Browser version returns an array format for console styling. Use the spread operator:
import { green } from "@visulima/colorize/browser";
console.log(...green("Success!")); // Note the spread operatorSubpath Exports
The package provides several specialized exports for advanced features:
// Template literals
import template from "@visulima/colorize/template";
// Gradient support
import { gradient, multilineGradient } from "@visulima/colorize/gradient";
// Utility functions
import { strip } from "@visulima/colorize/utils";Verification
Verify your installation by running a simple color test:
import { green, red, blue } from "@visulima/colorize";
console.log(green("✓ Installation successful!"));
console.log(blue("ℹ Colorize is ready to use"));
console.log(red.bold("● Colors are working"));If you see colored output, the installation is successful!
TypeScript Support
TypeScript definitions are included automatically. No additional @types packages are needed.
import type { ColorizeType } from "@visulima/colorize";
// Full type checking and autocomplete
const colorize: ColorizeType = (await import("@visulima/colorize")).default;Environment Variables
Colorize automatically detects and respects color support through environment variables:
NO_COLOR- Disables all colors when set to any valueFORCE_COLOR- Forces color output (values:0,1,2,3)COLORTERM- Detects TrueColor support (value:truecolor)
CLI flags are also supported:
--no-color- Disables colors--color- Forces color output