Skip to Main content

tuyen image create-icon-pack

Generate a complete icon pack including favicon, Apple touch, Android, and Windows tile icons from an SVG. Requires ImageMagick to be installed locally. To install ImageMagick, visit https://imagemagick.org/script/download.php.

Usage

tuyen image create-icon-pack [OPTIONS] --site-name <SITE_NAME> --site-short-name <SITE_SHORT_NAME> --description <DESCRIPTION> --theme-color <THEME_COLOR>

Options

-i, --input <INPUT>

  • Path to the source SVG file used as the base image.
  • Default value: favicon.svg.
  • Alias: src.

-o, --output <OUTPUT>

  • Directory to write the generated icon files into.
  • Default value: icons.
  • Alias: dest.

--root-path <ROOT_PATH>

  • Base URL path for icon references in manifest files.

--icons-path <ICONS_PATH>

  • URL path prefix for icon files in the web app manifest.

--assets-path <ASSETS_PATH>

  • URL path prefix for asset files in the manifest.

--manifest-path <MANIFEST_PATH>

  • Custom file path for the web app manifest output.

--browser-config-path <BROWSER_CONFIG_PATH>

  • Custom file path for the browserconfig.xml output.

--site-name <SITE_NAME>

  • Full name of the web application as it appears in the manifest.
  • Required: Yes.

--site-short-name <SITE_SHORT_NAME>

  • Short name of the web application used on home screens and launchers.
  • Required: Yes.

--description <DESCRIPTION>

  • Description of the web application for the manifest metadata.
  • Required: Yes.

--icon-prefix <ICON_PREFIX>

  • Filename prefix for all generated icon files.

--theme-color <THEME_COLOR>

  • Theme color for the web app manifest in hexadecimal notation.
  • Required: Yes.

--background-color <BACKGROUND_COLOR>

  • Background color for splash screens in hexadecimal notation.

--monochrome <MONOCHROME>

  • Generate monochrome icon variants for dark and light theme support.
  • Alias: mono.
  • Possible values: true, false.

--tile-color <TILE_COLOR>

  • Tile color for Windows tile icons in hexadecimal notation.

--maskable-shrink <MASKABLE_SHRINK>

  • Shrink ratio between 0.0 and 1.0 for the maskable icon safe zone.

--no-readme

  • Omit the README file from the generated output.
  • Default value: false.
  • Possible values: true, false.

-h, --help

  • Print help.