@hugeicons/migrate
Migrate your project from popular icon libraries to Hugeicons with ease
---
## Overview
`@hugeicons/migrate` is a powerful CLI tool that helps you migrate your React projects from popular icon libraries (Lucide, FontAwesome, Heroicons, Feather, Tabler, Phosphor) to [Hugeicons](https://hugeicons.com) â 46,000+ icons across 10 styles.
### Features
- đ **Smart Detection** - Automatically detects icon libraries used in your project
- đ **Detailed Planning** - Preview all changes before applying them
- đ **Safe Migration** - Creates automatic backups before making changes
- âŠī¸ **Easy Rollback** - Revert changes anytime with built-in restore
- đ **HTML Reports** - Generate beautiful migration reports
- đ¨ **Style Support** - Choose between Free and Pro icon styles
- đĻ **Auto Install** - Automatically installs required Hugeicons packages
## Installation
You can run the migration tool directly using `npx`:
```bash
npx @hugeicons/migrate
```
Or install it globally:
```bash
npm install -g @hugeicons/migrate
```
## Quick Start
### Interactive Mode
Simply run the CLI without arguments to enter interactive mode:
```bash
npx @hugeicons/migrate
```
This will:
1. Display a welcome message
2. Detect or let you choose the project folder
3. Present available commands (scan, plan, apply, revert)
### Command Line Mode
You can also run specific commands directly:
```bash
# Scan your project for icon usage
npx @hugeicons/migrate scan ./my-project
# Generate a migration plan
npx @hugeicons/migrate plan ./my-project
# Preview changes (dry run)
npx @hugeicons/migrate apply ./my-project
# Apply changes
npx @hugeicons/migrate apply ./my-project --write
# Revert to backup
npx @hugeicons/migrate revert ./my-project
```
## Commands
### `scan`
Scans your project to detect icon libraries and their usage.
```bash
npx @hugeicons/migrate scan
```
**Output includes:**
- Detected icon libraries (Lucide, FontAwesome, Heroicons, Feather, Tabler, Phosphor)
- Number of icon usages per library
- Files containing icons
### `plan`
Generates a detailed migration plan showing what will change.
```bash
npx @hugeicons/migrate plan
```
**Output includes:**
- Icon mapping (old â new)
- Files that will be modified
- Required Hugeicons packages
### `apply`
Applies the migration to your project.
```bash
# Dry run (preview changes)
npx @hugeicons/migrate apply
# Apply changes
npx @hugeicons/migrate apply --write
```
**Options:**
- `--write` - Actually apply the changes (without this, it's a dry run)
- `--style