2015-03-23 02:51:19 +00:00
# atom-shell-packager
Build a distributable app from an atom-shell app source code directory. **Currently only Mac OS is implemented** but you can send PRs to implement windows/linux :)
[](https://nodei.co/npm/atom-shell-packager/)
2015-04-04 16:47:01 +00:00
[](https://travis-ci.org/maxogden/atom-shell-packager)
2015-03-23 03:28:52 +00:00
For an example project using this, check out [Monu ](https://github.com/maxogden/monu )
2015-03-23 02:51:19 +00:00
### installation
```
2015-04-04 16:50:33 +00:00
# for use in npm scripts
npm i atom-shell-packager --save-dev
# for use from cli
npm i atom-shell-packager -g
# you also need atom-shell installed
npm i atom-shell
2015-03-23 02:51:19 +00:00
```
### usage
```
$ atom-shell-packager my-app-source-dir AppName
```
This will:
2015-04-04 16:48:24 +00:00
- Find the closest local version of `atom-shell` installed (using `require.resolve` )
- Use that version of atom-shell to create a Mac app in `cwd` called `AppName.app`
2015-03-23 02:51:19 +00:00
You should be able to double-click `AppName.app` to launch the app. If not, check your settings and try again.
2015-03-23 03:14:42 +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/atom-shell-packager` folder or `node_modules/atom-shell` . You can use `--ignore=node_modules/atom-shell` to ignore of these
2015-03-23 02:51:19 +00:00
### options
these are optional CLI options you can pass in
- `out` (default current working dir) - the dir to put the app into at the end
- `version` (default hardcoded in source) - atom-shell version to use
- `app-bundle-id` - bundle identifier to use in the app plist
- `helper-bundle-id` - bundle identifier to use in the app helper plist
2015-03-23 03:14:42 +00:00
- `ignore` (default none) - do not copy files into App whose filenames regex .match this string
2015-03-23 21:58:28 +00:00
- `prune` - runs `npm prune --production` on the app
