npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@kumori/binary-install

v1.2.3

Published

A npm package to install cli binaries

Downloads

15

Readme

binary-cli-install

binary-cli-install is a tool to install CLIs written in go, rust, c, etc with npm/yarn into a node project.

Release

Software License

Build status

Install


$ npm install --dev-save binary-cli-install

$ yarn add -D binary-cli-install

How to use it

  1. Create a new npm package (needed props: [version, bin, binary])

  2. Create a entrypoint.js and set as as the bin file in your package.json

  3. Add a binary object to your package.json with

  • name property set to the name of your cli

  • url property set to the download link

  1. Import the Binary class, initialize it and call the run method

Example

// package.json
{
  "name": "runtime-env",
  "version": "0.0.0",
  "bin": {
    "exmplae": "entrypoint.js"
  },
  "files": ["entrypoint.js"],
  "dependencies": {
    "binary-cli-install": "file:/home/simon/src/binary-cli-install/"
  },
  "binary": {
    "name": "runtime-env",
    "url": "https://github.com/example/example/releases/download/v{{version}}/runtime-env_{{version}}_{{platform}}_{{arch}}.tar.gz"
  }
}
// entrypoint.js

// importing both the Binary class and Mapper obejcts specificly for go to map the node arch & platform names to the go names

const {
  Binary,
  GO_ARCH_MAPPING,
  GO_PLATFORM_MAPPING,
} = require("binary-cli-install");

// import your package.json

const { join } = require("path");
const packageJson = require(join("..", "package.json"));

// Pass the mappers and your package.json to the Binary class

const bin = new Binary(
  packageJson,
  GO_ARCH_MAPPING,
  GO_PLATFORM_MAPPING,
  false // set debug to true with info messages should be logged
);

bin.run();

How it works

Your entrypoint.js script will be put into the node_modules/.bin folder when your package is installed. It acts as a placeholder and will be replaced after the first execution with the binary CLI. To keep a consistent user experience, the js script will call the binary on the first run every run afterwards will just be the binary cli no js wrapper.