electron-catalyst/usage.txt

Package for electron app publishing which drastically decreases bundle size by caching the prerequisites for apps to work. It depends catalyst binary (cenkalti/catalyst).

Usage: electron-catalyst <sourcedir> <appname> --platform=<platform> --arch=<arch> --version=<Electron version>

Required options

platform           all, or one or more of: linux, win32, darwin (comma-delimited if multiple)
arch               all, ia32, x64
version            the version of Electron that is being packaged, see https://github.com/atom/electron/releases

Example            electron-catalyst . FooBar --platform=darwin --arch=x64 --version=0.36.5

Optional options

all                equivalent to --platform=all --arch=all
app-bundle-id      bundle identifier to use in the app plist (darwin platform only)
app-category-type  the application category type (darwin platform only).
                   For example, `app-category-type=public.app-category.developer-tools` will set the application category to 'Developer Tools'.
app-version        release version to set for the app
asar               packages the source code within your app into an archive
asar-unpack        unpacks the files to app.asar.unpacked directory whose filenames regex .match this string
asar-unpack-dir    unpacks the dir to app.asar.unpacked directory whose names match this string. It's relative to the <sourcedir>.
                   For example, `--asar-unpack-dir=sub_dir` will unpack the directory `/<sourcedir>/sub_dir`.
build-version      build version to set for the app
cache              directory of cached Electron downloads. Defaults to '$HOME/.electron'
generate-config    only generates catalyst config
catalystOnly       creates catalyst version of given app
helper-bundle-id   bundle identifier to use in the app helper plist (darwin platform only)
icon               the icon file to use as the icon for the app. Note: Format depends on platform.
ignore             do not copy files into app whose filenames regex .match this string
out                the dir to put the app into at the end. defaults to current working dir
overwrite          if output directory for a platform already exists, replaces it rather than skipping it
prune              runs `npm prune --production` on the app
sign               should contain the identity to be used when running `codesign` (only for building for the darwin platform, on OS X)
strict-ssl         whether SSL certificates are required to be valid when downloading Electron.
                   It defaults to true, use --strict-ssl=false to disable checks.
tmpdir             temp directory. Defaults to system temp directory.
version-string     should contain a hash of the application metadata to be embedded into the executable (win32 platform only).
                   These can be specified on the command line via dot notation,
                   e.g. --version-string.CompanyName="Company Inc." --version-string.ProductName="Product"
                   Keys supported:
                   - CompanyName
                   - LegalCopyright
                   - FileDescription
                   - OriginalFilename
                   - FileVersion (deprecated, use --build-version instead)
                   - ProductVersion (deprecated, use --app-version instead)
                   - ProductName
                   - InternalName