ns Docsns Docs

Installation

Install nstypocolors and start using it in your Node.js or TypeScript projects.

nstypocolors can be used as a library, a CLI tool, or both, depending on your workflow.

Install as a Project Dependency


For most projects, install nstypocolors locally:

npm install nstypocolors

Using pnpm or yarn:

pnpm add nstypocolors
yarn add nstypocolors

This installation includes:

  • Full TypeScript typings
  • Color and gradient utilities
  • Built-in gradient presets
  • Optional CLI support

Installing nstypocolors locally is recommended for libraries, bots, and applications.

Global CLI Installation


If you want to use the CLI globally via the nstc command:

npm install -g nstypocolors

Verify the installation:

nstc --help

This allows you to use nstypocolors directly from your terminal without importing it into a project.

Node.js Requirements


  • Node.js ≥ 20
  • A modern terminal with ANSI color support is recommended

Older Node.js versions may work, but they are not officially supported.

Stable vs Beta Releases


By default, npm installs the latest stable version.

To try beta releases:

npm install nstypocolors@beta

Beta versions may include:

  • New gradients
  • Experimental CLI features
  • Breaking API changes

Beta releases are intended for testing only. Use them in production at your own risk.

What Gets Installed


After installation, you get:

  • Tree-shakable color functions
  • Gradient logging utilities
  • Optional CLI (nstc)
  • Zero configuration required

No setup files. No configuration. Just import and use.

Last updated on

On this page