# aebs

> A helper utility for creating and publising Electron applications

Latest version **1.1.0** (published 2019-01-12) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install aebs
pnpm add aebs
yarn add aebs
bun add aebs
```

Provides the command `aebs`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-01-12 |
| First published | 2018-11-09 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 179.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jacob Radatz |
| Maintainers | imburnis |
| Keywords | electron, creation, publishing |

## Links

- npm: https://www.npmjs.com/package/aebs
- Repository: https://github.com/imburnis/aebs
- Homepage: https://github.com/imburnis/aebs#readme
- Issues: https://github.com/imburnis/aebs/issues
- npm.io page: https://npm.io/package/aebs

## Dependencies (8)

- [asar](https://npm.io/package/asar.md) ^0.14.5
- [plist](https://npm.io/package/plist.md) ^3.0.1
- [rcedit](https://npm.io/package/rcedit.md) ^1.1.1
- [semver](https://npm.io/package/semver.md) ^5.6.0
- [png2icons](https://npm.io/package/png2icons.md) ^1.0.1
- [decompress-zip](https://npm.io/package/decompress-zip.md) ^0.3.1
- [command-line-args](https://npm.io/package/command-line-args.md) ^5.0.2
- [command-line-usage](https://npm.io/package/command-line-usage.md) ^5.0.5

## Recent versions

- 1.1.0 (latest) — 2019-01-12
- 1.0.2 — 2018-11-09
- 1.0.1 — 2018-11-09
- 1.0.0 — 2018-11-09

## README

# AEBS - Another Electron Build Script
There are many packagers for Electron out there, and many of them have a very large development community. So why bother making another packaging tool?

Well, the answer to that is simple! I wanted something simple that I could expand as I need different functionality while I mess around with Electron.

## Usage
This utility is meant to be installed as a global node package so it can be run from the command line.

```shell
aebs [command] <options>
```

| Command | Functionality |
| ------- | ------------- |
| create  | Similar to the NPM Init command. This creates a new project and adds npm scripts for all of the build commands in this package. Also asks for some additional information for customizing the final electron builds |
| build   | Packages the electron application into an asar file, asks the user for which version/architecture to use, and customizes the final build |
| clean   | Empties the build directory |
| sassy   | Compiles any files in the scss folder under the src directory of the project to the css folder |
| asar    | Packages the electron application into a .asar file into the build directory |

With the build command, there is an option to specify a cache directory so that a zip file of the Electron release doesn't need to be redownloaded every time.
```shell
aebs create -c "/path/to/cache"
```

## Install Instructions
This package is currently available through the npm package manager.

```shell
npm -i aebs -g
```

## Creating a new Project
```shell
/parent/dir/of/new/project$:aebs create
<Answer Prompts>
/parent/dir/of/new/project$:cd ./project-name
/parent/dir/of/new/project$:npm install
/parent/dir/of/new/project$:npm run start
```

## Note
If using the sass (any .scss files in the sass directory) you _must_ have sass installed globally so you can run sass from the command line.

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