electron-build

0.0.3 • Public • Published

electron-build

Upload your app (html, css, js) to the Electron Build Service (www.electronbuild.com) to package it up into an installable Windows or Mac App.

Getting Started

This package provides a command line for the Electron Build Service. You will need a username and password on www.electronbuild.com in order to use this tool.

> npm install electron-build -g

Once installed, you can access it via command line:

> ebuild mySourceFolder --app MyAppName

This will upload everything in the folder mySourceFolder and package it up as an app called "MyAppName". It will wait until complete and then download the packages to the local folder

  • For Windows this will create an installer called InstallMyAppName.exe
  • For Mac this will create an installer called MyAppName.dmg
  • Linux downloads coming soon....

Automatically entering username & password

Use the flags --username and --password (or -u and -p) as below:

> ebuild mySourceFolder --app MyAppName --username [username] --password [password]

Where [username] and [password] are your login credentials at www.electronbuild.com

Other Flags

  --app         Specify the application's name or alternatively specify the appid (alternative flag is -a)
  --username    Your username at www.electronbuild.com
  --password    Your password at www.electronbuild.com
  --list        List all applications and downloads you have created (alternative flag is -l)  
  --verbose     Log verbose information (alternative flag is -v)
  --skipwait    Dont wait to download installations. Just upload to Electron Build for processing (alternative flag is -sw)

Getting Help

This will display all command line options.

> ebuild --help

Why have a build service?

The Electron Build Service provides these features that do not come with the free Electron tools:

  • A Mac, Windows (& soon to come Linux) installs without requiring that hardware
  • Offloading of the heavy lifting of building for each of those platforms (ie faster builds)
  • Packaging of the app in a simple installation with its own icon
  • App is available in Windows "Add/Remove programs" and is uninstallable and versioned

Readme

Keywords

none

Package Sidebar

Install

npm i electron-build

Weekly Downloads

174

Version

0.0.3

License

MIT

Last publish

Collaborators

  • damiant