pphat.me logoRegistry
Home/FAQ

Frequently Asked Questions

Answers to common questions about installing, configuring, and using @pphatdev/registry. For deep-dive usage, see the documentation.

How do I install @pphatdev/registry?

You do not need to install anything permanently. Run the CLI directly with npx: `npx pphat init` creates a pphatdev.json config in your project root. Then use `npx pphat add-icon <name>` or `npx pphat add-component <name>` to fetch what you need. If you use it often, install globally with `npm install -g @pphatdev/registry`.

What frameworks does @pphatdev/registry support?

Three output formats: React / Next.js as .tsx files, Vue / Nuxt as .vue single-file components, and raw .svg for framework-agnostic use.

How do I add an icon to my project?

Run `npx pphat add-icon <name>` in your project root — for example, `npx pphat add-icon react vue github`. The CLI uses the format defined in your pphatdev.json, or you can override it with `-f nextjs`, `-f nuxtjs`, or `-f svg`, and set a custom destination with `-d <path>`.

How do I add a component to my project?

Run `npx pphat add-component <name>`, for example `npx pphat add-component button card modal -f nextjs -d src/components/ui`. The same -f and -d flags apply.

Where do the icons and components come from?

They are fetched on demand from the public GitHub repositories pphatdev/icons and pphatdev/registry.pphat.me via raw.githubusercontent.com. There is no proprietary server or rate-limited API in the middle.

Do I need an account or API key?

No. Everything is fetched from a public GitHub CDN. There are no logins, tokens, or subscriptions.

What is the pphatdev.json file?

A configuration file at your project root that stores your default output format (SVG, Next.js, or Nuxt) and destination directories for icons and components. It is generated by `npx pphat init` and can be edited manually or updated with `npx pphat config`.

Can I browse icons before installing?

Yes. Visit the Icon Studio at https://registry.pphat.me/icons for live search, per-icon customization (size, stroke width, color), and one-click export to SVG, React, or Vue.

Is @pphatdev/registry free?

Yes. It is open source under the MIT license.

Who created @pphatdev/registry?

Sophat LEAT (PPhat) — https://pphat.me. Released on 18 July 2026 under the MIT license.