2015-04-27 19:09:24 +00:00
# electron-packager
2015-03-23 02:51:19 +00:00
2015-05-10 20:57:42 +00:00
Package your electron app in OS executables (.app, .exe, etc) via JS or CLI. Supports building Windows, Linux or Mac executables.
2015-03-23 02:51:19 +00:00
2015-04-27 19:09:24 +00:00
*formerly known as atom-shell-packager*
2015-03-23 02:51:19 +00:00
2015-04-27 19:09:24 +00:00
[](https://nodei.co/npm/electron-packager/)
[](https://travis-ci.org/maxogden/electron-packager)
2015-04-04 16:47:01 +00:00
2015-03-23 02:51:19 +00:00
### installation
```
2015-04-04 16:50:33 +00:00
# for use in npm scripts
2015-04-27 19:09:24 +00:00
npm i electron-packager --save-dev
2015-04-04 16:50:33 +00:00
# for use from cli
2015-04-27 19:09:24 +00:00
npm i electron-packager -g
2015-03-23 02:51:19 +00:00
```
### usage
```
2015-05-10 20:57:42 +00:00
Usage: electron-packager < sourcedir > < appname > --platform=< platform > --arch=< arch > --version=< version >
Required options
platform linux, win32, darwin
arch ia32, x64
version see https://github.com/atom/electron/releases
Example electron-packager ./ FooBar --platform=darwin --arch=x64 --version=0.25.1
Optional options
out the dir to put the app into at the end. defaults to current working dir
icon the icon file to use as the icon for the app
app-bundle-id bundle identifier to use in the app plist
app-version version to set for the app
helper-bundle-id bundle identifier to use in the app helper plist
ignore do not copy files into App whose filenames regex .match this string
prune runs `npm prune --production` on the app
asar packages the source code within your app into an archive
2015-03-23 02:51:19 +00:00
```
This will:
2015-05-10 20:57:42 +00:00
- Find or download the correct release of Electron
- Use that version of electron to create a app in `cwd` named using `appname` for the platform you specified
2015-03-23 02:51:19 +00:00
2015-05-10 20:57:42 +00:00
You should be able to launch the app on the platform you built for. If not, check your settings and try again.
2015-03-23 02:51:19 +00:00
2015-04-27 19:09:24 +00:00
**Be careful** not to include node_modules you don't want into your final app. For example, do not include the `node_modules/electron-packager` folder or `node_modules/electron-prebuilt` . You can use `--ignore=node_modules/electron-prebuilt` to ignore of these
