Skip to content

Download and extract binaries from compressed packages

Notifications You must be signed in to change notification settings

felipecrs/bindl

Repository files navigation

bindl

Download and extract binaries from compressed packages.

ci Version Downloads/week License Conventional Commits semantic-release

Usage

$ npm install --global bindl

$ bindl --help
Downloads and extracts binaries from compressed packages using a config file.

━━━ Usage ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

$ bindl

━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  -c,--config #0    Path to the config file

━━━ Details ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

The config will be read from any valid config file in the current directory. The
configuration file can be defined using all the extensions and names accepted by
**cosmiconfig** such as `bindl.config.cjs`.

━━━ Examples ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Download binaries looking for the config file in the current directory
  $ bindl

Download binaries looking for the config file at `./dir/bindl.config.cjs`
  $ bindl --config ./dir/bindl.config.cjs

You can find an example of a config file here.

Environment variables

When called without any environment variables, bindl downloads all packages from the config file, not matter the platform or architecture.

However, some environment variables can be used to tweak the behavior of bindl:

BINDL_SKIP

When the BINDL_SKIP environment variable is set to a truthy like 1 or true, bindl will skip downloading anything.

npm_config_arch

When the npm_config_arch environment variable is set, bindl will only download the packages that match the given architecture for the current architecture.

For example, if you set npm_config_arch=x64 and you are running on Linux, bindl will only download the packages that match the linux platform and the x64 architecture, skipping all other packages.