# @vite-pwa/assets-generator

> Zero-config PWA Assets Generator

Latest version **2.0.0** (published 2026-09-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vite-pwa/assets-generator
pnpm add @vite-pwa/assets-generator
yarn add @vite-pwa/assets-generator
bun add @vite-pwa/assets-generator
```

Provides the command `pwa-assets-generator`.

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2026-09-12 |
| First published | 2023-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=20.19.0 |
| Dependencies | 6 |
| Unpacked size | 73.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 165 |
| Author | antfu <anthonyfu117@hotmail.com> |
| Maintainers | antfu, userquin |
| Keywords | sharp, sharp-ico, pwa, pwa icons generator, pwa assets generator |

## Links

- npm: https://www.npmjs.com/package/@vite-pwa/assets-generator
- Repository: https://github.com/vite-pwa/assets-generator
- Homepage: https://github.com/vite-pwa/assets-generator#readme
- Issues: https://github.com/vite-pwa/assets-generator/issues
- Funding: https://github.com/sponsors/antfu
- npm.io page: https://npm.io/package/@vite-pwa/assets-generator

## Dependencies (6)

- [cac](https://npm.io/package/cac.md) ^7.0.0
- [sharp](https://npm.io/package/sharp.md) ^0.35.4
- [consola](https://npm.io/package/consola.md) ^3.4.2
- [unconfig](https://npm.io/package/unconfig.md) ^7.5.0
- [sharp-ico](https://npm.io/package/sharp-ico.md) ^0.1.5
- [picocolors](https://npm.io/package/picocolors.md) ^1.1.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2026-09-12
- 1.0.4 — 2026-09-12
- 1.0.3 — 2026-09-12
- 1.0.2 — 2025-10-14
- 1.0.1 — 2025-09-07
- 1.0.0 — 2025-03-29
- 0.2.6 — 2024-09-04
- 0.2.5 — 2024-09-02
- 0.2.4 — 2024-02-11
- 0.2.3 — 2024-01-13
- 0.2.2 — 2023-12-26
- 0.2.1 — 2023-12-13
- 0.2.0 — 2023-12-12
- 0.1.0 — 2023-12-10
- 0.0.11 — 2023-11-16
- … 10 more at https://npm.io/package/@vite-pwa/assets-generator/versions

## README

<p align='center'>
<img src='./hero.svg' alt="@vite-pwa/assets-generator - Zero-config PWA Assets Generator"><br>
Zero-config PWA Assets Generator
</p>

<p align='center'>
<a href='https://www.npmjs.com/package/@vite-pwa/assets-generator' target="__blank">
<img src='https://img.shields.io/npm/v/@vite-pwa/assets-generator?color=33A6B8&label=' alt="NPM version">
</a>
<a href="https://www.npmjs.com/package/@vite-pwa/assets-generator" target="__blank">
    <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vite-pwa/assets-generator?color=476582&label=">
</a>
<a href="https://vite-pwa-org.netlify.app/assets-generator" target="__blank">
    <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
</a>
<br>
<a href="https://github.com/vite-pwa/assets-generator" target="__blank">
<img alt="GitHub stars" src="https://img.shields.io/github/stars/vite-pwa/assets-generator?style=social">
</a>
</p>

<br>

<p align="center">
  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
  </a>
</p>

## 🚀 Features

- 📖 [**Documentation & guides**](https://vite-pwa-org.netlify.app/)
- 👌 **Zero-Config**: sensible built-in default configs for common use cases
- 🔩 **Extensible**: expose the full ability to customize the behavior of the plugin
- 🦾 **Type Strong**: written in [TypeScript](https://www.typescriptlang.org/)
- 🔌 **Offline Support**: generate service worker with offline support (via Workbox)
- ⚡ **Fully tree shakable**: auto inject Web App Manifest
- 💬 **Prompt for new content**: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact
- ⚙️ **Stale-while-revalidate**: automatic reload when new content is available
- ✨ **Static assets handling**: configure static assets for offline support
- 🐞 **Development Support**: debug your custom service worker logic as you develop your application
- 🛠️ **Versatile**: integration with meta frameworks: [îles](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), [Nuxt 3](https://github.com/nuxt/nuxt) and [Remix](https://github.com/remix-run/remix)
- 💥 **PWA Assets Generator**: generate all the PWA assets from a single command and a single source image
- 🚀 **PWA Assets Integration**: serving, generating and injecting PWA Assets on the fly in your application

## 📦 Install

```bash
# npm
npm i @vite-pwa/assets-generator -D

# yarn
yarn add @vite-pwa/assets-generator -D

# pnpm
pnpm add @vite-pwa/assets-generator -D
```

## 🦄 Usage

Create `pwa-assets.config.js` or `pwa-assets.config.ts` file in your root project folder and configure a preset and the images to use to generate the PWA assets:

```ts
import { defineConfig, minimal2023Preset as preset } from '@vite-pwa/assets-generator/config'

export default defineConfig({
  preset,
  images: [
    'public/logo.svg',
    'public-dev/logo.svg'
  ]
})
```

then, add the following script to your `package.json` and run it:

```json
{
  "scripts": {
    "generate-pwa-assets": "pwa-assets-generator"
  }
}
```

Read the [📖 documentation](https://vite-pwa-org.netlify.app/assets-generator) for a complete guide on how to configure and use
`@vite-pwa/assets-generator` CLI.

To use this library programmatically, check out the [API documentation](https://vite-pwa-org.netlify.app/assets-generator/api).

## 👀 Full config

Check out the type declaration [src/config.ts](./src/config.ts) for more details.

## 📄 License

[MIT](./LICENSE) License &copy; 2023-PRESENT [Anthony Fu](https://github.com/antfu)

---
_Source: https://npm.io/package/@vite-pwa/assets-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._