# atom-shell-packager

> package and distribute your atom-shell app in OS executables (.app, .exe, etc) via JS or CLI

Latest version **2.1.1** (published 2015-04-05) · BSD license · 0 weekly downloads

## Install

```sh
npm install atom-shell-packager
pnpm add atom-shell-packager
yarn add atom-shell-packager
bun add atom-shell-packager
```

Provides the command `atom-shell-packager`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2015-04-05 |
| First published | 2015-03-23 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 302 |
| Author | max ogden |
| Maintainers | maxogden, remixz, mafintosh |

## Links

- npm: https://www.npmjs.com/package/atom-shell-packager
- Repository: https://github.com/maxogden/atom-shell-packager
- Issues: https://github.com/maxogden/atom-shell-packager/issues
- npm.io page: https://npm.io/package/atom-shell-packager

## Dependencies (5)

- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [plist](https://npm.io/package/plist.md) ^1.1.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [rimraf](https://npm.io/package/rimraf.md) ^2.3.2
- [minimist](https://npm.io/package/minimist.md) ^1.1.1

## Recent versions

- 2.1.1 (latest) — 2015-04-05
- 2.1.0 — 2015-04-05
- 2.0.0 — 2015-04-04
- 1.2.0 — 2015-03-24
- 1.1.0 — 2015-03-23
- 1.0.0 — 2015-03-23

## README

# 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](https://nodei.co/npm/atom-shell-packager.png)](https://nodei.co/npm/atom-shell-packager/)

[![Build Status](https://travis-ci.org/maxogden/atom-shell-packager.svg?branch=master)](https://travis-ci.org/maxogden/atom-shell-packager)

For an example project using this, check out [Monu](https://github.com/maxogden/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

---
_Source: https://npm.io/package/atom-shell-packager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._