Installation & Quick Start

A quick start guide to using the @pphatdev/registry CLI.

Usage via npx (Recommended)

You don't need to install anything. Run the CLI directly using npx:

The CLI supports multiple convenient aliases (prefixes), so you can use any of the following interchangeably:

Global Installation (Optional)

If you plan to use the CLI frequently across many projects, install it globally on your machine:

Then use the short commands anywhere:

Step-by-Step Workflow

1. Initialize your project

Run the init command to set up your preferences. It interactively prompts you for configuration and writes a pphatdev.json file at the root of your project:

Example interactive setup:

? What is name of config ? › Default configuration
? What do you want to use ? (required must select one) › Icons

? Which directory you want to use ? (required must select one) › Nextjs format (.tsx)
? Where do you store icon of nextjs ? › components/icons

Success! Configuration saved to pphatdev.json.

2. View & Manage Configuration

View or update your stored configuration anytime using the config command:

Or fetch / set specific keys:

3. Discover Items in the Registry

Browse available icons or components using the list (or ls) command with pagination:

4. Add Icons or Components

Download icons or components directly into your project. Since v1.4.0 the CLI accepts two equivalent grammars — pick whichever reads best:

Subcommand grammar

Hyphenated grammar

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

Custom target directory or format

Override your default configuration on the fly using -d (--dir) or -f (--format):

5. Remove Icons or Components

New in v1.4.0 — the remove command family deletes files an equivalent add would have written. Missing files are treated as "already gone" (exit 0), and each format reports Removed X (N files).

Hyphenated aliases also work (remove-icon, remove-component, remove-comp), and the same -f / -d flags apply: