Go to file
Max Ogden 1d44672807 add devdep 2015-04-04 21:19:53 -07:00
downloaded update name 2015-03-22 19:55:15 -07:00
.gitignore gitignore 2015-03-22 19:55:57 -07:00
.travis.yml dont download atom-shell -- use local version instead 2015-04-04 09:47:01 -07:00
cli.js dont download atom-shell -- use local version instead 2015-04-04 09:47:01 -07:00
collaborators.md add collaborator 2015-04-04 21:13:39 -07:00
index.js dont download atom-shell -- use local version instead 2015-04-04 09:47:01 -07:00
package.json add devdep 2015-04-04 21:19:53 -07:00
readme.md update install instructions. closes #8 2015-04-04 09:50:33 -07:00

readme.md

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 :)

NPM

Build Status

For an example project using this, check out Monu

installation

# 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

usage

$ atom-shell-packager my-app-source-dir AppName

This will:

  • 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

You should be able to double-click AppName.app to launch the app. If not, check your settings and try again.

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

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
  • ignore (default none) - do not copy files into App whose filenames regex .match this string
  • prune - runs npm prune --production on the app