Downloads binaries directly or from archives as defined in a config file.
$ npm install -D bindl
$ npx bindl --help
Downloads binaries directly or from archives as defined in a config file
━━━ Usage ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
$ bindl
━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-c,--config #0 Path to the configuration file
━━━ Details ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Downloads binaries as defined in the configuration file.
The configuration file can have any of the names and extensions accepted by
cosmiconfig such as bindl.config.js.
When no configuration file is specified, a valid configuration file will be
searched in the current directory.
━━━ Examples ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Download binaries looking for the configuration file in the current directory
$ bindl
Download binaries looking for the configuration file at ./dir/bindl.config.js
$ bindl --config ./dir/bindl.config.jsbindl supports two types of binary downloads:
Download and extract files from archives like .tar.gz, .zip, etc.:
import { defineConfig } from "bindl";
export default defineConfig({
binaries: [
{
platform: "linux",
arch: "x64",
url: "https://example.com/tool.tar.gz",
// Optional: SHA256 hash to verify the downloaded archive
sha256: "abc123...",
// Optional: extract or remap specific files
files: [
{
source: "tool-v1.0.0/bin/tool",
target: "tool",
},
],
// Optional: strip directory components
stripComponents: 1,
// Optional: validate the downloaded binary
tests: [
{
command: "./tool --version",
expectedOutputContains: "v1.0.0",
},
],
},
],
});Supported archive formats include .tar.gz, .tar.bz2, .tar.xz, .tar, and .zip.
Download single executable files directly:
import { defineConfig } from "bindl";
export default defineConfig({
binaries: [
{
platform: "linux",
arch: "x64",
url: "https://example.com/tool-linux-amd64",
type: "file",
// Required for single file downloads
filename: "tool",
// Optional: SHA256 hash to verify the downloaded file
sha256: "def456...",
// Optional: set executable permissions on non-Windows platforms (default: true)
executable: true,
// Optional: validate the downloaded binary
tests: [
{
command: "./tool --version",
expectedOutputContains: "v1.0.0",
},
],
},
],
});When called without any environment variables, bindl downloads all binaries from the config file, regardless of the platform or architecture.
However, some environment variables can be used to tweak the behavior of bindl:
When the BINDL_SKIP environment variable is set to a truthy value like 1 or true, bindl will skip downloading anything.
When the BINDL_CURRENT_ONLY environment variable is set to a truthy value like 1 or true, bindl will only download the binaries that match the current platform and architecture.
When the npm_config_arch environment variable is set, bindl will only download the binaries that match the given architecture for the current platform.
For example, if you set npm_config_arch=x64 and you are running on Linux, bindl will only download the binaries that match the linux platform and the x64 architecture, skipping all other binaries.