favicli
v1.0.2
Published
Auto-set favicons in React & Next.js projects from any image
Readme
favicli
One command to set up favicons for React and Next.js projects.
Detect project -> choose image -> generate all favicon sizes -> inject references.
Author
- Name: Zain Afzal
- Website: https://zainafzal.dev
- Email: [email protected]
Installation
npm install -g favicliOr run without global install:
npx favicliQuick Usage
# Home menu
favicli
# Interactive setup
favicli set
# Set from a specific image
favicli set logo.png
# Detect project type
favicli detect
# Remove generated favicon files
favicli removeCommands
favicli set [image]
- Generates favicon files into
public/ - Auto-injects/replaces references in project files
Options:
-d, --dir <path>: target project directory--no-inject: generate files only, skip injection
Examples:
favicli set
favicli set logo.png
favicli set ./assets/icon.png -d ./apps/web
favicli set logo.png --no-injectfavicli detect
Detects project type and shows project details.
favicli detect
favicli detect -d ./apps/webfavicli remove
Removes generated favicon files from public/.
favicli remove
favicli remove -d ./apps/webSupported Projects
- React + Vite
- Create React App
- Next.js App Router
- Next.js Pages Router
Monorepo support:
- Scans root, direct subfolders,
apps/*, andpackages/*
Generated Files
Inside public/:
favicon.icofavicon-16x16.pngfavicon-32x32.pngfavicon-48x48.pngapple-touch-icon.pngandroid-chrome-192x192.pngandroid-chrome-512x512.pngsite.webmanifest
Notes
- Re-running
favicli setupdates existing generated files. - Injection is replacement-based, so favicon references are updated on reruns.
Repository
- GitHub: https://github.com/sheikhmuhammadzain/favicli
- Issues: https://github.com/sheikhmuhammadzain/favicli/issues
License
MIT
