https://github.com/ragingwind/pwa-manifest-cli

Cli for Creating a Web Manifest for Progressive Web App with interactive or command mode
https://github.com/ragingwind/pwa-manifest-cli

Last synced: 11 months ago
JSON representation

Cli for Creating a Web Manifest for Progressive Web App with interactive or command mode

• Host: GitHub
• URL: https://github.com/ragingwind/pwa-manifest-cli
• Owner: ragingwind
• License: mit
• Created: 2016-04-09T15:03:18.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-06-28T07:37:39.000Z (about 9 years ago)
• Last Synced: 2025-04-25T11:06:01.545Z (about 1 year ago)
• Language: JavaScript
• Size: 234 KB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

          
# pwa-manifest-cli [![Build Status](https://travis-ci.org/ragingwind/pwa-manifest-cli.svg?branch=master)](https://travis-ci.org/ragingwind/pwa-manifest-cli)

> Generating manifest, icons and favicon.ico for Progressive Web App by interactive or command mode

Using in interactive mode

![](http://g.recordit.co/kwR4Dh7rM3.gif)

, or manually

```sh

 pwa-manifest --icons=./images/logo.png

```

, or with free icons from [iconfinder.com](https://iconfinder.com/) with [if-got-cli](https://github.com/ragingwind/if-got-cli)

```sh

pwa-manifest ./ ./image/icons --icons=$(if-got icons search --query=love)

```

## Install

```

$ npm install -g pwa-manifest-cli

```

## Usage

```sh

$ pwa-manifest   

```

Get more information via help

## Examples

```shell

# show help

$ pwa-manifest --help

# Icon from iconfinder

$ pwa-manifest ./ ./image/icons --icons=$(if-got icons search --query=love --count=1)

# generate manifest.json and resized icons to `./app`.

$ pwa-manifest ./app --icons=./logo.png

# generate manifest.json to `./app` and icons to `./app/images/icons`

$ pwa-manifest ./app ./app/images/icons --icons=./logo.png

# generate manifest.json to './' with updated values of name, short_name, background_color, theme_color, orientation, and direction as well as resizes images

$ pwa-manifest --name='My Progressive Web App' --short_name='My PWA' --display=fullscreen --background_color=#fefefe --theme_color=#f44336 --orientation=any --direction=portrait --icons=./images/logo.png

# using interactive mode for generating manifest.json and resized images to current working path

$ pwa-manifest --interactive

```

## Options in details

### --icons

`path` or `http address` can be used for icons of source image. It will generated those of icons in multiple sizes (144, 192 and 512) and named by size of image into manifest. There is no way to be able to be changed by option yet. `favicon.ico` will be created from icons files at same location of `manifest.json`

## License

MIT © [Jimmy Moon](http://ragingwind.me)