# electron-installer-snap

> Build snapcraft packages for Electron applications

Latest version **5.2.0** (published 2022-07-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install electron-installer-snap
pnpm add electron-installer-snap
yarn add electron-installer-snap
bun add electron-installer-snap
```

Provides the command `electron-installer-snap`.

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.2.0 |
| Published | 2022-07-25 |
| First published | 2017-09-26 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 10.0 |
| Dependencies | 10 |
| Unpacked size | 367 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 53 |
| Author | Mark Lee |
| Maintainers | vertedinde, erickzhao, marshallofsound, malept, zeke, develar |
| Keywords | electron, installer, snap, snapcraft, linux |

## Links

- npm: https://www.npmjs.com/package/electron-installer-snap
- Repository: https://github.com/electron-userland/electron-installer-snap
- Homepage: https://github.com/electron-userland/electron-installer-snap#readme
- Issues: https://github.com/electron-userland/electron-installer-snap/issues
- Funding: https://github.com/electron-userland/electron-installer-snap?sponsor=1
- npm.io page: https://npm.io/package/electron-installer-snap

## Dependencies (10)

- [debug](https://npm.io/package/debug.md) ^4.3.4
- [which](https://npm.io/package/which.md) ^2.0.1
- [yargs](https://npm.io/package/yargs.md) ^16.0.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [semver](https://npm.io/package/semver.md) ^7.1.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.0
- [tmp-promise](https://npm.io/package/tmp-promise.md) ^3.0.2
- [electron-installer-common](https://npm.io/package/electron-installer-common.md) ^0.10.2
- [@malept/cross-spawn-promise](https://npm.io/package/@malept/cross-spawn-promise.md) ^1.0.0

## Recent versions

- 5.2.0 (latest) — 2022-07-25
- 5.1.0 — 2020-04-26
- 5.0.0 — 2020-01-21
- 4.1.0 — 2019-11-21
- 4.0.0 — 2019-06-20
- 3.2.0 — 2019-05-03
- 3.1.1 — 2019-02-22
- 3.1.0 — 2019-01-07
- 3.0.1 — 2018-12-26
- 3.0.0 — 2018-07-17
- 2.0.1 — 2018-02-22
- 2.0.0 — 2018-01-31
- 1.0.1 — 2017-09-26
- 1.0.0 — 2017-09-26

## README

# Electron Installer: Snap

[![Build Status](https://github.com/electron-userland/electron-installer-snap/workflows/CI/badge.svg)](https://github.com/electron-userland/electron-installer-snap/actions?query=workflow:CI)
[![Code Coverage](https://codecov.io/gh/electron-userland/electron-installer-snap/branch/master/graph/badge.svg)](https://codecov.io/gh/electron-userland/electron-installer-snap)

Builds Snap files for Electron applications that have already been bundled and customized.

## Requirements

Requires Node 10 or greater, and [`snapcraft`](https://snapcraft.io).

## Quick Start

The easiest way is to use [Electron Forge](https://electronforge.io) and enable the `snap` maker.

To use this as a standalone CLI, install `electron-installer-snap` to your project:

```shell
npm install --save-dev electron-installer-snap
# or
yarn add --dev electron-installer-snap
```

Then add to your `package.json`:

```javascript
{
  // ...
  "scripts": {
    "build:package": "electron-packager . --out=out"
    "build:snap": "electron-installer-snap --src=out/myappname-linux-x64"
  },
  // ...
}
```

Then you can run `npm run build:package && npm run build:snap`, which will prepare the Electron app
for bundling and generate a `.snap` file in your current directory.
It is recommended to ignore the generated `snap` directory in your version control.

## Options

Available command-line options are displayed when you run `electron-installer-snap --help`.

For the JavaScript API, please see the [API docs](https://electron-userland.github.io/electron-installer-snap/).

## Thanks

Thank you to Canonical for the support in getting this module created, during the September 2017
Ubuntu Rally and the January 2018 Snapcraft Summit.

## Legal

This project is copyrighted under the Apache License (version 2). See LICENSE for details.

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