熟悉 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 messagecontent_paste
查看任何命令的說明
$ icongenie [command_name] --helpcontent_paste
產生
generate 命令用於產生應用程式圖示和啟動畫面。它是 Icon Genie 的核心，負責繁重的工作。
請看下方關於用法和一些範例。最需要注意的參數是 --icon (或 -i)，它接受透明 PNG 作為應用程式圖示和啟動畫面的輸入。PNG 的最小尺寸為 64x64 像素，但強烈建議使用 1024x1024 像素以上。
對於啟動畫面，如果您希望將圖示放置在背景之上，則可以將其與 --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 messagecontent_paste
驗證
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 messagecontent_paste
設定檔
Icon Genie 也支援設定檔。這些檔案是 JSON 格式，並告訴 Icon Genie 要產生哪些圖像以及如何產生它們。profile 命令是一個輔助工具，用於建立這些設定檔的骨架。如果需要，它們對於自動化非常有用。
JSON 設定檔的通用格式是
{
"params": { },
"assets": [ ]
}content_paste
您也可以產生多個設定檔 (具有不同的參數/設定)。如需更多資訊，請前往 設定檔 頁面。
$ 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: 40content_paste