CLI reference

Run without installing via npx splashforge, or install globally with npm i -g splashforge. Requires Node ≥ 18.3.

Commands

generate

Render a full design spec (splash and/or icon) from a config file.

splashforge generate --config splashforge.config.json --out ./assets [--zip] \
  [--mode splash|icon|both] [--targets id,id] [--bundle kinds --license KEY]

icon / splash

Quick, config-free generation from flags.

splashforge icon   --logo logo.svg --bg "#6366f1,#a855f7" --out ./assets [--zip]
splashforge splash --logo logo.svg --text "Acme" --bg "#0a0a0f" --out ./assets

Flags

Flag	Description
--config <file>	JSON design spec (generate)
--out <dir>	Output directory (default ./splashforge-assets)
--mode <m>	splash, icon, or both (generate; default: whatever the config has)
--targets <list>	Comma-separated target ids, or omit for all
--logo <file>	Logo path/URL (quick mode)
--bg <color>	#hex solid, or #hex,#hex gradient
--text <string>	App name (quick mode)
--font <family> · --color <hex>	Text styling (quick mode)
--zip	Also write a .zip bundle
--bundle <kinds>	Pro native bundles: xcassets,android,ico,icns,svg
--license <key>	Pro license key (or set SPLASHFORGE_LICENSE)
-h, --help · -v, --version

Output layout

Icons are foldered by platform (iOS/, Android/, Favicon/); splash screens are flat. With --bundle, native containers are written under their conventional paths (AppIcon.appiconset/…, res/mipmap-…/…).

CI example

- run: npx splashforge generate --config splashforge.config.json --out ./build/assets