Skip to content
Install binary applications via npm
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
src
.gitignore
LICENSE
README.md
index.js
package-lock.json
package.json

README.md

binary-install

Install .tar.gz binary applications via npm

Usage

This library provides a single class Binary that takes a download url and some optional arguments. You must provide either name or installDirectory when creating your Binary.

option decription
name The name of your binary
installDirectory A path to the directory to install the binary

If an installDirectory is not provided, the binary will be installed at your OS specific config directory. On MacOS it defaults to ~/Library/Preferences/${name}-nodejs

After your Binary has been created, you can run .install() to install the binary, and .run() to run it.

Example

This is meant to be used as a library - create your Binary with your desired options, then call .install() in the postinstall of your package.json, .run() in the bin section of your package.json, and .uninstall() in the preuninstall section of your package.json. See this example project to see how to create an npm package that installs and runs a binary using the Github releases API.

You can’t perform that action at this time.