# @fweinb/electron-prebuilt

> Install electron (formerly called atom-shell) prebuilts using npm

Latest version **0.27.4** (published 2015-06-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @fweinb/electron-prebuilt
pnpm add @fweinb/electron-prebuilt
yarn add @fweinb/electron-prebuilt
bun add @fweinb/electron-prebuilt
```

Provides the command `electron`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.27.4 |
| Published | 2015-06-08 |
| First published | 2015-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 751 |
| Author | Mathias Buus |
| Maintainers | fweinb |

## Links

- npm: https://www.npmjs.com/package/@fweinb/electron-prebuilt
- Repository: https://github.com/mafintosh/electron-prebuilt
- Issues: https://github.com/mafintosh/electron-prebuilt/issues
- npm.io page: https://npm.io/package/@fweinb/electron-prebuilt

## Dependencies (3)

- [rc](https://npm.io/package/rc.md) ^1.0.3
- [extract-zip](https://npm.io/package/extract-zip.md) ^1.0.3
- [electron-download](https://npm.io/package/electron-download.md) ^1.0.0

## Recent versions

- 0.27.4 (latest) — 2015-06-08
- 0.27.3 — 2015-06-08

## README

# electron-prebuilt

[![build status](http://img.shields.io/travis/mafintosh/electron-prebuilt.svg?style=flat)](http://travis-ci.org/mafintosh/electron-prebuilt)

Install [electron](https://github.com/atom/electron) (formerly called **atom-shell**) prebuilt binaries for command-line use using npm.

Works on Mac, Windows and Linux OSes that Electron supports (e.g. Electron [does not support Windows XP](https://github.com/atom/electron/issues/691)).

Electron is a javascript runtime that bundles Node.js and Chromium. You use it similar to the `node` command on the command line for executing javascript programs. This module helps you easily install the `electron` command for use on the command line without having to compile anything.

## Installation

Download and install the latest build of electron for your OS and add it to your projects `package.json` as a `devDependency`:

```
npm install electron-prebuilt --save-dev
```

This is the preferred way to use electron, as it doesn't require users to install electron globally.

You can also use the `-g` flag (global) to symlink it into your PATH:

```
npm install -g electron-prebuilt
```

If that command fails with an `EACCESS` error you may have to run it again with `sudo`:

```
sudo npm install -g electron-prebuilt
```

Now you can just run `electron` to run electron:

```
electron
```

## Usage

First you have to [write an electron application](https://github.com/atom/electron/blob/master/docs/tutorial/quick-start.md)

Then you can run your app using:

```
electron your-app/
```

## Programmatic usage

If you require `electron-prebuilt` inside your node app it will return the file path to the binary.
Use this to spawn electron

``` js
var electron = require('electron-prebuilt')
var proc = require('child_process')

// will something similar to print /Users/maf/.../Electron
console.log(electron)

// spawn electron
var child = proc.spawn(electron)
```

You can use a file called `.electron-prebuildrc` to specify the downloaded version that electron-prebuild will download.

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