Using Icons

Download, manage, and remove custom vector icons directly in your frontend project using the @pphatdev/registry CLI.

---

Quick Start

1. Initialize Configuration

Select Icons and choose your preferred formats (svg, nextjs, or nuxtjs) and destination paths.

2. Browse Available Icons

3. Add Icons

Since v1.4.0 the CLI accepts two equivalent grammars. Both write the same files based on your pphatdev.json:

Subcommand grammar

Hyphenated grammar

npx pphat add react (no subcommand) is preserved as a legacy shortcut for add icon react.

---

Format & Directory Overrides

To download an icon into a specific folder or format without updating pphatdev.json:

Download as Next.js (.tsx) Component

Download as Nuxt.js (.vue) Component

Download as Raw SVG

Custom Output Directory

---

Removing Icons

Use remove icon (or the hyphenated remove-icon) to delete previously downloaded icons. Removal mirrors add's path resolution, so it only touches files an equivalent add would have written. Missing files are treated as "already gone" — no error, exit 0.

Remove from Every Enabled Format

Restrict to a Specific Format or Directory