Skip to content
This repository has been archived by the owner on May 23, 2022. It is now read-only.

Latest commit

 

History

History
76 lines (51 loc) · 1.62 KB

README.md

File metadata and controls

76 lines (51 loc) · 1.62 KB

lock.js

js-standard-style Build Status

Lock your Node.js project into an executable.

Installation

npm install -g lockjs

Feature

  • One binary executable.
  • Capable to handle the C++ addons.
  • Capable to handle the a lot fs methods which not use file descriptor.
  • Always run with the latest Node.js. (link the shared library at compiling time)

Quick Start

Create a locked project and get a public key by specifying the path and entry point of it:

$ lockjs lock path/to/project path/to/project/lib/index.js ./project.locked

// ....
// [lockjs] Locked file: "project.locked".
// [lockjs] Key: "yourPublicKey".

Create an executable from the locked project and its public key:

$ lockjs gen ./project.locked ./app.o yourPublicKey

Update LD_LIBRARY_PATH:

export `lockjs link`

Rock and roll:

$ ./app.o

Support Platform

  • Mac OS X
  • Linux 64 bit
  • Linux 32 bit

Environment Required

  • clang
  • Node.js > 4

Help

Usage: lockjs [options] [command]

Commands:

  lock <projectPath> <entryPoint> <dest>  lock specified node.js project and generate a public key
  gen <packedProject> <dest> <publicKey>  generate a executable from the locked and the public key
  install                                 install latest node.js header files and shared library

Options:

  -h, --help     output usage information
  -V, --version  output the version number