Saas.js logo
@saas-js/iconify/Getting Started

Installation

Install and set up @saas-js/iconify in your project

Installation

Install the package

You can install @saas-js/iconify using your preferred package manager:

# Using npm
npm install @saas-js/iconify

# Using yarn
yarn add @saas-js/iconify

# Using pnpm
pnpm add @saas-js/iconify

# Using bun
bun add @saas-js/iconify

Run without installation

You can also run @saas-js/iconify directly without installing it:

# Initialize configuration
npx @saas-js/iconify init

# Add icons
npx @saas-js/iconify add --set lucide home user settings

Global installation

For frequent use, you can install globally:

npm install -g @saas-js/iconify

Then use the icons command directly:

icons init
icons add --set lucide home user settings

Verification

After installation, verify that the CLI is working:

# Check version
icons --version

# Display help
icons --help

Next Steps

Overview

A CLI tool for fetching and generating type-safe React icon components from the extensive Iconify icon library.

Basic Usage

Learn how to use @saas-js/iconify to generate React icon components