CLI Usage

Use nstypocolors directly from the terminal with the nstc command-line interface.

nstypocolors ships with a lightweight CLI called nstc, allowing you to print colored and gradient text directly from the terminal.

It is intentionally minimal, fast, and requires no configuration.

The CLI is ideal for scripts, build logs, CI output, local tooling, and quick experiments.

Installation

If installed globally:

npm install -g nstypocolors

Or run it without installing using npx:

npx nstypocolors "Hello World" --green

Both approaches provide access to the nstc command.

Basic Syntax

nstc "<message>" <option>

<message> — The text you want to print
<option> — A color or gradient flag

If no option is provided, a default gradient is applied.

nstc "nstypocolors CLI running successfully!"

Solid Color Examples

Use solid colors for simple, predictable output.

nstc "Success message" --green
nstc "Error message" --red
nstc "Info message" --blue
nstc "Warning message" --yellow

These map directly to the color utilities available in the library API.

Bright Colors

Bright variants provide stronger emphasis and should be used sparingly.

nstc "Bright success" --bright-green
nstc "Bright warning" --bright-yellow
nstc "Bright error" --bright-red

Bright colors are best reserved for high-signal messages such as failures or completions.

Pastel Colors

Pastel colors offer a softer, UI-like appearance.

nstc "Soft UI message" --pastel-blue
nstc "Aesthetic output" --pastel-lavender
nstc "Friendly notice" --pastel-mint

These are especially useful for help menus and developer tools.

Background Pastel Colors

Background-highlighted output works well for labels or short status indicators.

nstc "Highlighted warning" --back-pastel-yellow
nstc "Important notice" --back-pastel-red

Use these for one-word or short emphasis only.

Gradient Presets

Semantic gradients are available directly from the CLI.

nstc "Build completed successfully" --success
nstc "Fetching data from server..." --info
nstc "Caution: disk space low" --warn
nstc "Fatal error occurred" --error
nstc "Compiling project..." --build

Gradient presets follow the same intent-based philosophy as the library API.

Rainbow Output

A rainbow mode is also available:

nstc "VIBGIOUR" --rainbow

Rainbow output is intentionally loud — use it sparingly and avoid it in production logs.

To view all supported flags and options:

nstc --help

This includes:

All color flags
Gradient presets
Usage examples

Notes

The CLI works fully offline after installation
ANSI colors require a compatible terminal
Windows Terminal, PowerShell, and modern Linux shells are supported

If colors do not appear, verify that your terminal supports ANSI escape codes.