Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

binarium

Package Overview
Dependencies
Maintainers
0
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

binarium

Zero-configuration node library and CLI for building executables for all platforms and architectures

  • 0.1.6
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6
decreased by-87.76%
Maintainers
0
Weekly downloads
 
Created
Source

Binarium - Build node binaries with zero config

Web About Us Donate Github Twitter Instagram Medium

License Version

Index

📖 Description

Package your Node.js project into an executable that can be run even on devices without Node.js installed.

The construction of the binary allows compilation on arm and x64 architecture.

If you compile on an x64 system it will not create the binaries for arm, but if you compile on arm it will create the binaries for both architectures.

This library works thanks to ncc, pkg and esbuild, which facilitate this process.

Using binarium is simple and will work in most cases, but that may not be the case. If so, we recommend using other alternatives such as pkg.

🔑 Installation

npm install binarium
# or pnpm
pnpm add binarium
# or yarn
yarn add binarium

📈 usage

Node example

import { build } from 'binarium'

await build( {
 input  : 'src/cli.js', // JS or TS file
 name   : 'app-name', // default is input filename
} )

CLI example

binarium --input=src/server.js --name=app-name

Options

All of these options are available with the binarium command by adding the suffix -- and followed by an = and its value.

type BuilderParams = {
 /**
  * The app server input file.
  *
  * The input can be provided without an extension. 
  * If the extension is omitted, the system will automatically look for the following extensions: `.ts`, `.js`, `.mjs`, `.mts`.
  */
 input: string, 
 /**
  * Binary name.
  */
 name?: string,
 /**
  * Directory for the output build.
  *
  * @default './build'
  */
 outDir?: string, 
 /**
  * Build only binary for your current OS.
  *
  * @default false
  */
 onlyOs?: boolean
 /**
  * The build type Result [all|cjs|bin].
  *
  * @default 'all'
  */
 type?: 'all'|'cjs'|'bin'
 
}

👨‍💻 Development

binarium is an open-source project and its development is open to anyone who wants to participate.

Issues Pull requests Read more

☕ Donate

Help us to develop more interesting things.

Donate

📜 License

This software is licensed with GPL-3.0.

Read more

🐦 About us

PigeonPosse is a ✨ code development collective ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.

More

Collaborators

NameRoleGitHub
AngeloAngeloAuthor & Development@Angelo
PigeonPossePigeonPosseCollective@PigeonPosse

Web About Us Donate Github Twitter Instagram Medium

Keywords

FAQs

Package last updated on 28 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc