熟悉 Quasar 项目文件夹中可用的 Icon Genie CLI 命令列表
$ icongenie
Example usage
$ icongenie <command> <options>
Help for a command
$ icongenie <command> --help
$ icongenie <command> -h
Options
--version, -v Print Quasar Icon Genie CLI version
Commands
generate, g Generate App icons & splash screens
verify, v Verify your Quasar app's icons &
splash screens
profile, p Create Icon Genie profile files
help, h Display this message粘贴内容
查看任何命令的帮助
$ icongenie [command_name] --help粘贴内容
生成
该 generate 命令用于生成应用图标和启动画面。它是 Icon Genie 的核心，因为它承担了繁重的工作。
请查看下面的用法和一些示例。需要注意的最重要的参数是 --icon（或 -i），它接收一个透明的 PNG 作为应用图标和启动画面的输入。PNG 的最小尺寸为 64x64px，但强烈建议使用大于 1024x1024px 的尺寸。
对于启动画面，如果希望将图标放置在背景之上，可以将其与 --background（或 -b）一起使用。
您可能还想使用--profile（或-p）参数，它可以运行一个或多个 Icon Genie 配置文件。
$ icongenie generate -h
Description
Generate App icons & splash screens
Usage
$ icongenie generate [options]
# generate icons for all installed Quasar modes
$ icongenie generate -i /path/to/icon.png
$ icongenie g -i /path/to/icon.png
# generate for (as example) PWA mode only
$ icongenie generate -m pwa --icon /path/to/icon.png
# generate for (as example) Cordova & Capacitor mode only
$ icongenie g -m cordova,capacitor -i
/path/to/icon.png -b /path/to/background.png
# generate by using a profile file
$ icongenie generate -p ./icongenie-profile.json
# generate by using batch of profile files
$ icongenie generate -p ./folder-containing-profile-files
Options
--icon, -i Required;
Path to source file for icon; must be:
- a .png file
- min resolution: 64x64 px (the higher the better!!)
- with transparency
Best results are with a square image (height = width)
Image will be trimmed automatically
(also see "skip-trim" and "padding" param)
Path can be absolute, or relative to the root of the
Quasar project folder
Recommended min size: 1024x1024 px
--background, -b Path to optional background source file (for splash screens);
must be:
- a .png file
- min resolution: 128x128 px (the higher the better!!)
- transparency is optional (but recommended if you
combine with the splashscreen-color param)
Path can be absolute, or relative to the root of the
Quasar project folder
Recommended min size: 1024x1024 px
--mode, -m For which Quasar mode(s) to generate the assets;
Default: all
[all|spa|pwa|ssr|bex|cordova|capacitor|electron]
Multiple can be specified, separated by ",":
spa,cordova
--filter, -f Filter the available generators; when used, it can
generate only one type of asset instead of all
[png|ico|icns|splashscreen|svg]
--quality Quality of the files [1 - 12] (default: 5)
- higher quality --> bigger filesize & slower to create
- lower quality --> smaller filesize & faster to create
--skip-trim Do not trim the icon source file
--padding Apply fixed padding to the icon after trimming it;
Syntax: <horiz: number>,<vert: number>
Default: 0,0
Example: "--padding 10,5" means apply 10px padding to top
10px to bottom, 5px to left side and 5px to rightside
--theme-color Theme color to use for all generators requiring a color;
It gets overridden if any generator color is also specified;
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--svg-color Color to use for the generated monochrome svgs
Default (if no theme-color is specified): 1976D2
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--png-color Background color to use for the png generator, when
"background: true" in the asset definition (like for
the cordova/capacitor iOS icons);
Default (if no theme-color is specified): fff
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--splashscreen-color Background color to use for the splashscreen generator;
Default (if no theme-color is specified): fff
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--splashscreen-icon-ratio Ratio of icon size in respect to the width or height
(whichever is smaller) of the resulting splashscreen;
Represents percentages; Valid values: 0 - 100
If 0 then it doesn't add the icon of top of background
Default: 40
--profile, -p Use JSON profile file(s):
- path to folder (absolute or relative to current folder)
that contains JSON profile files (icongenie-*.json)
- path to a single *.json profile file (absolute or relative
to current folder)
Structure of a JSON profile file:
{
"params": {
"include": [ ... ], /* optional */
...
},
"assets": [ /* list of custom assets */ ]
}
--help, -h Displays this message粘贴内容
验证
verify命令确认您是否在正确的位置拥有所有必需的应用图标和启动画面，以及每个文件是否具有正确的像素分辨率。
$ icongenie -h
Description
Verifies your Quasar App's icons and splash screens
for all installed modes.
Usage
$ icongenie verify [options]
# verify all Quasar modes
$ icongenie verify
# verify specific mode
$ icongenie verify -m spa
# verify with specific filter
$ icongenie verify -f ico
# verify by using a profile file
$ icongenie verify -p ./icongenie-profile.json
# verify by using batch of profile files
$ icongenie verify -p ./folder-containing-profile-files
Options
--mode, -m For which Quasar mode(s) to verify the assets;
Default: all
[all|spa|pwa|ssr|bex|cordova|capacitor|electron]
Multiple can be specified, separated by ",":
spa,cordova,capacitor
--filter, -f Filter the available generators; when used, it verifies
only one type of asset instead of all
[png|ico|icns|splashscreen|svg]
--profile Use JSON profile file(s) to extract the asset list to verify:
- path to folder (absolute or relative to current folder)
that contains JSON profile files (icongenie-*.json)
- path to a single *.json profile file (absolute or relative
to current folder)
Structure of a JSON profile file:
{
"params": {
"include": [ ... ], /* optional */
...
},
"assets": [ /* list of custom assets */ ]
}
--help, -h Displays this message粘贴内容
配置文件
Icon Genie 还支持配置文件。这些文件采用 JSON 格式，并告诉 Icon Genie 生成哪些图像以及如何生成它们。profile命令是用于创建这些配置文件的辅助工具。如果需要，它们对于自动化非常有用。
JSON 配置文件的通用形式为
{
"params": { },
"assets": [ ]
}粘贴内容
您还可以生成多个配置文件（使用不同的参数/设置）。有关更多信息，请访问配置文件页面。
$ icongenie profile -h
Description
Helper command to easily bootstrap Icon Genie profile files.
Usage
$ icongenie profile -o <filename> [options]
# supplying params list
$ icongenie profile -o <filename> --include pwa,spa --quality 7
# supplying assets based on Icon Genie's internal list
$ icongenie profile -o <filename> --assets spa,bex
Options
--output, -o Name of the new Icon Genie profile file
--assets, -a Prefill the assets Array with Icon Genie's
internal list, based on the modes that you indicate;
[all|spa|pwa|ssr|bex|cordova|capacitor|electron]
Multiple can be specified, separated by ",":
spa,cordova
--icon, -i Path to source file for icons; must be:
- a .png file
- min resolution: 64x64 px (the higher the better!!)
- with transparency
Best results are with a square image (height = width)
Image will be trimmed automatically
(also see "skip-trim" and "padding" param)
Path can be absolute, or relative to the root of the
Quasar project folder
Recommended min size: 1024x1024 px
--background, -b Path to optional background source file (for splash screens);
must be:
- a .png file
- min resolution: 128x128 px (the higher the better!!)
- transparency is optional (but recommended if you
combine with the splashscreen-color param)
Path can be absolute, or relative to the root of the
Quasar project folder
Recommended min size: 1024x1024 px
--include Prefill the params.include property;
[all|spa|pwa|ssr|bex|cordova|capacitor|electron]
Multiple can be specified, separated by ",":
spa,cordova
--filter, -f Prefill the params.filter property;
[png|ico|icns|splashscreen|svg]
--quality Prefill in the params.quality property;
Quality of the files [1 - 12] (default: 5)
- higher quality --> bigger filesize & slower to create
- lower quality --> smaller filesize & faster to create
--skip-trim Do not trim the icon source file
--padding Apply fixed padding to the icon after trimming it;
Syntax: <horiz: number>,<vert: number>
Default: 0,0
Example: "--padding 10,5" means apply 10px padding to top
10px to bottom, 5px to left side and 5px to rightside
--theme-color Prefill the params.themeColor property;
Theme color to use for all generators requiring a color;
It gets overridden if any generator color is also specified;
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--svg-color Prefill the params.svgColor property;
Color to use for the generated monochrome svgs
Default (if no theme-color is specified): 1976D2
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--png-color Prefill the params.pngColor property;
Background color to use for the png generator, when
"background: true" in the asset definition (like for
the Cordova/Capacitor iOS icons);
Default (if no theme-color is specified): fff
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--splashscreen-color Prefill the params.splashscreenColor property;
Background color to use for the splashscreen generator;
Default (if no theme-color is specified): fff
The color must be in hex format (NOT hexa) without the leading
'#' character. Transparency not allowed.
Examples: 1976D2, eee
--splashscreen-icon-ratio Prefill the params.splashscreenIconRatio property;
Ratio of icon size in respect to the width or height
(whichever is smaller) of the resulting splashscreen;
Represents percentages; Valid values: 0 - 100
If 0 then it doesn't add the icon of top of background
Default: 40粘贴内容