https://github.com/mscdex/install-addons

A program to install precompiled node addons from Github
https://github.com/mscdex/install-addons

Last synced: about 1 month ago
JSON representation

A program to install precompiled node addons from Github

• Host: GitHub
• URL: https://github.com/mscdex/install-addons
• Owner: mscdex
• License: mit
• Created: 2021-11-20T18:14:33.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-22T02:22:54.000Z (about 3 years ago)
• Last Synced: 2024-11-19T00:46:06.752Z (about 2 months ago)
• Language: JavaScript
• Size: 30.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Description

===========

`install-addons` downloads and installs prebuilt node addons (when possible)

from Github. It is the companion node module to the [build-addons][] Github

Action.

How to Use

==========

1. Make sure you have [build-addons][] correctly providing binaries for

   downloading.

2. Add the following to your **package.json**:

    ```js

    "install-addons": {

      "binaryRepo": "/",

      "binaryOutPath": "build/Release/.node"

      "buildCommand": "",

      "preBuildCommand": "",

      "buildDependencies": {

        "": ""

      },

      "usesNapi": ,

    }

    ```

    * `binaryRepo` - A **required** string containing the user and repository

      name of where prebuilt versions of this node addon can be found.

    * `binaryOutPath` - A **required** string containing the path where prebuilt

      binaries should be downloaded to. Typically this will be something like

      `'build/Release/mybinding.node'`.

    * `buildCommand` - A **required** string that contains the command to

      build the addon. Typically this will simply be `'node-gyp rebuild'` for

      most addons.

    * `preBuildCommand` - An optional string containing a command to execute

      before executing `buildCommand`. This is useful if you have an additional

      step to configure/prepare things first (e.g. generate .gypi files).

    * `buildDependencies` - An optional object containing dependencies that need

      to be installed before a local build can take place. For example, you

      would put `nan` or similar npm packages here.

    * `usesNapi` - An optional boolean that indicates whether this addon

      utilizes napi/node-api. This is used when checking for compatible prebuilt

      addons.

3. Call `node-install-addons` from an install script:

    ```js

      "scripts": {

        "install": "node-install-addons"

      },

    ```

4. You're done!

CLI Parameters

==============

These are parameters that you can specify in your npm install command.

* `--build-from-source[=]` - If a string value is given, it builds from

  source only for the specified (comma-separated) packages that use

  `install-addons`. If the value is `'false'`, the behavior is disabled for all

  packages that use `install-addons`. If the value `'true'` or no string value

  is given, then it builds from source for all packages that use

  `install-addons`.

* `--fallback-to-build[=]` - Attempts to build the addon locally only if

  a compatible binary cannot be found. If a string value is given, it falls back

  to building from source only for the specified (comma-separated) packages that

  use `install-addons`. If the value is `'false'`, the behavior is disabled for

  all packages that use `install-addons`. If the value `'true'` or no string

  value is given, then it falls back to building from source for all packages

  that use `install-addons`. **Note:** The default behavior is to fallback to

  building.

* `--override-arch=` - Overrides the local host architecture with the

  architecture given in the specified string.

* `--override-libc=` - Overrides the local host libc with the

  libc given in the specified string. This string can contain the libc name

  or be of the format: `{name}_{majorVersion.minorVersion}`.

* `--override-platform=` - Overrides the local host platform with the

  platform given in the specified string. This string can contain the platform

  name or be of the format: `{name}_{majorVersion.minorVersion}`.

* `--silent-build` - When building from source, no compilation output will be

  logged.

[build-addons]: https://github.com/mscdex/build-addons