-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
35 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
|
||
# XSEA: Cross-Platform Single Executable Applications | ||
|
||
XSEA is a utility for generating Node.js Single Executable Applications (SEAs) cross-platform. At the moment, there is only a CLI, not an API. | ||
|
||
## CLI | ||
|
||
Here is the output of `xsea --help`: | ||
|
||
``` | ||
Usage: xsea [...options] <entry point> | ||
Options: | ||
--help,-h Show this help message | ||
--quiet,-q Hide non-error output | ||
--verbose,-w Show all output | ||
--output, -o <prefix> The output prefix | ||
--clean Remove temporary files | ||
--node,-N <version> Specify the Node version | ||
--target, -t <target> Specify which targets(s) to build for (e.g. linux-arm64, win-x64) | ||
``` | ||
|
||
#### Examples | ||
|
||
Generate x64 executables for Linux, Windows, and MacOS: | ||
|
||
```sh | ||
xsea src/my-program.js -o dist/my-program -t linux-x64 -t win-x64 -t darwin-x64 | ||
``` | ||
|
||
Generate executables for Windows on x64 and Arm: | ||
|
||
```sh | ||
xsea src/my-program.js -o dist/my-program -t win-arm64 -t win-x64 | ||
``` |