pphat.me logoRegistry
Docs/commands

CLI Commands

A complete reference for every command exposed by the @pphatdev/registry CLI.

You can run the CLI via global installation (pphat) or directly via npx. The following invocations are equivalent:

❯npx pphat <command>
❯npx pphatdev <command>
❯npx pphatdev <command>

init

Interactively initializes project preferences and generates a pphatdev.json file in the project root.

❯npx pphat init

Prompts will guide you through selecting resource types (icons, components), formats (SVG, Next.js, Nuxt.js), and storage paths.

config

View and update configuration settings interactively or programmatically.

Interactive Configuration

❯npx pphat config

Get Configuration

❯npx pphat config get
❯npx pphat config get icons.nextjs.dir

Set Configuration

❯npx pphat config set icons.nextjs.use true

list / ls

Lists available icons or components in the registry with interactive page-by-page browsing.

❯npx pphat list icons
❯npx pphat ls components

add-icon / add

Downloads one or multiple icons from the registry into your project.

❯npx pphat add-icon react vue github

Options

| Flag | Long Flag | Description | | --- | --- | --- | | -f | --format <fmt> | Specify output format (svg, nextjs, nuxtjs) | | -d | --dir <path> | Specify destination directory |

Examples

❯npx pphat add-icon react vue -d src/assets/icons
❯npx pphat add-icon github -f nextjs

add-component / add-comp

Downloads one or multiple UI components from the registry.

❯npx pphat add-component button card modal

Options

| Flag | Long Flag | Description | | --- | --- | --- | | -f | --format <fmt> | Specify output format (nextjs, nuxtjs) | | -d | --dir <path> | Specify destination directory |

Examples

❯npx pphat add-component button -f nextjs -d src/components/ui
PreviousConfiguration
NextUsing Icons