🌸 Pumki CLI

Table of Contents

• Features
• Installation
• Quickstart
• Usage
• Example
• Components
• Troubleshooting
• Contributing
• License

✨ Features

• One-liner component install
• Auto-detects and uses your package manager
• Fetches components directly from pumki-ui
• Cross-platform support: macOS, Linux, Windows, WSL
• Lightweight and blazing fast

📦 Installation

Option 1: Use without installation (recommended ✅)

No installation needed — run directly with your package manager:

npm

npx pumki add <component-name>

npx pumki add stats-carousel

pnpm

pnpm dlx pumki add stats-carousel

yarn

yarn dlx pumki add stats-carousel

Bun

# macOS/Linux
bunx pumki add stats-carousel
# or (works everywhere)
bun x pumki add stats-carousel

# Windows (PowerShell/CMD) — use this:
bun x pumki add stats-carousel

Note: bunx is a symlink available on macOS/Linux. On Windows, use bun x.

Option 2: Global install (for convenience)

If you want to avoid typing npx every time:

# npm
npm i -g pumki

# pnpm
pnpm add -g pumki

# yarn
yarn global add pumki

# bun
bun add -g pumki

Then you can run:

pumki add stats-carousel

⚡ Quickstart

Add any component from Pumki-UI into your project in one line:

npx pumki add stats-carousel

That’s it. Pumki fetches the component JSON from pumki-ui and scaffolds it into your project, integrating with your package manager automatically.

🛠 Usage

# Add a component by name
npx pumki add <component-name>

# Example
npx pumki add stats-carousel

💡 Tips:

• Component names map to entries in pumki-ui.
• Want shorter commands? → Install globally and just run pumki add ….

📥 Example

Command:

npx pumki add stats-carousel

Output:

✨ Adding stats-carousel from Pumki-UI...
✔ Component added successfully!

🧩 Components

Browse the full catalog:

• https://github.com/AnshSinghSonkhia/pumki-ui/tree/main/public/r

❓ Troubleshooting

• Command not found
  • If installed globally, make sure you used: npm i -g pumki
  • Then run: pumki add <component>
  • If installed locally, run with npx (or your package manager’s equivalent): npx pumki add <component>
• Permission errors on global install (macOS/Linux)
  • Try: npm i -g pumki --unsafe-perm
  • Or use a Node version manager (nvm, fnm)
• Wrong package manager being used
  • Pumki auto-detects, but you can ensure a lockfile (package-lock.json, pnpm-lock.yaml, yarn.lock, bun.lockb) exists before running.
  • If none exist, it defaults to npm.

If you hit an issue, please open an issue with your OS, Node version, package manager, and command used.

🤝 Contributing

Contributions are welcome!

1. Fork this repo
2. Create a feature branch
3. Commit your changes
4. Push and open a PR 🎉

📜 License

MIT © Ansh Singh Sonkhia

If you find Pumki useful, consider starring the repo to support the project. 🌟