Craig Condon
66 lines
1.1 KiB
Markdown
66 lines
1.1 KiB
Markdown
#### Nexe is a command-line utility that compiles your Node.js application into a single executable file.
|
|
|
|
### Motivation
|
|
|
|
- Ability to run multiple applications with *different* node.js runtimes.
|
|
- Distributable binaries without needing node / npm.
|
|
- Starts faster.
|
|
- Lockdown specific application versions, and easily rollback.
|
|
- Faster deployments.
|
|
|
|
## Requirements
|
|
|
|
- Linux / Mac
|
|
|
|
## Caveats
|
|
|
|
- Doesn't support native modules (yet).
|
|
- Doesn't support windows (yet).
|
|
|
|
## Installation
|
|
|
|
Via NPM:
|
|
|
|
```bash
|
|
npm install nexe [-g]
|
|
```
|
|
|
|
Or git:
|
|
|
|
```bash
|
|
git clone
|
|
```
|
|
|
|
### CLI Usage
|
|
|
|
````text
|
|
|
|
Usage: nexe -i [sources] -o [binary]
|
|
|
|
Options:
|
|
-i, --input The entry javascript files [default: cwd]
|
|
-o, --output The output binary [default: cwd/release/app.nex]
|
|
-r, --runtime The node.js runtime to use [default: "0.8.15"]
|
|
-t, --temp The path to store node.js sources [default: /tmp/nexe]
|
|
|
|
|
|
````
|
|
|
|
|
|
### Code usage
|
|
|
|
````javascript
|
|
|
|
var nexe = require('nexe');
|
|
|
|
nexe.compile({ input: 'input.js', output: 'path/to/bin', runtime: '0.8.15' } function() {
|
|
|
|
});
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
|