Blame: lib/help.js - vercel/pkg - Morph

SIGN IN SIGN UP

vercel / pkg UNCLAIMED

Package your Node.js project into an executable

0 0 0 JavaScript

Normal View History Raw

-												--help

											
										
										
											2016-08-31 19:25:38 +03:00
+								import chalk from 'chalk';
 								export default function help () {
 								  console.log(`
 								  ${chalk.bold('pkg')} [options] <input>
 								  ${chalk.dim('Options:')}
 								    -h, --help       output usage information
-												[cli] Show version (#59)


											
										
										
											2017-05-03 20:17:26 +02:00
+								    -v, --version    output pkg version
-												--help

											
										
										
											2016-08-31 19:25:38 +03:00
+								    -t, --targets    comma-separated list of targets (see examples)
-												Revert "ditched dedicated configs in favor of package.json.pkg"

This reverts commit d99995e9f3887c63febd8245f4f869b64f397cd6.

											
										
										
											2017-07-19 19:24:49 +03:00
+								    -c, --config     package.json or any json file with top-level config
-												readme: install, targets

											
										
										
											2016-10-06 11:03:44 +03:00
+								    --options        bake v8 options into executable to run with them on
-												--help

											
										
										
											2016-08-31 19:25:38 +03:00
+								    -o, --output     output file name or template for several files
-												out-dir -> out-path (no change in tests to test deprecated support)

											
										
										
											2017-06-12 21:07:55 +03:00
+								    --out-path       path to save output one or more executables
-												add help entry about --options + minor wording

											
										
										
											2016-09-29 13:12:23 +03:00
+								    -d, --debug      show more information during packaging process [off]
-												pass `build` argument as `forceBuild` to pkg-fetch

											
										
										
											2016-09-01 13:26:06 +03:00
+								    -b, --build      don't download prebuilt base binaries, build them
-												test for general native addon use

											
										
										
											2017-07-15 18:59:12 +03:00
+								    --public         speed up and disclose the sources of top-level project
-												--help

											
										
										
											2016-08-31 19:25:38 +03:00
 								  ${chalk.dim('Examples:')}
-												Replace OSX with macOS

											
										
										
											2016-09-07 11:06:28 +02:00
+								  ${chalk.gray('–')} Makes executables for Linux, macOS and Windows
-												added `out-dir` and examples to help.js

											
										
										
											2016-09-06 21:51:18 +03:00
+								    ${chalk.cyan('$ pkg index.js')}
 								  ${chalk.gray('–')} Takes package.json from cwd and follows 'bin' entry
 								    ${chalk.cyan('$ pkg .')}
-												--help

											
										
										
											2016-08-31 19:25:38 +03:00
+								  ${chalk.gray('–')} Makes executable for particular target machine
-												hint about alpine in help.js

											
										
										
											2017-01-21 19:05:05 +03:00
+								    ${chalk.cyan('$ pkg -t node6-alpine-x64 index.js')}
-												add help entry about --options + minor wording

											
										
										
											2016-09-29 13:12:23 +03:00
+								  ${chalk.gray('–')} Makes executables for target machines of your choice
-												added `out-dir` and examples to help.js

											
										
										
											2016-09-06 21:51:18 +03:00
+								    ${chalk.cyan('$ pkg -t node4-linux,node6-linux,node6-win index.js')}
-												add help entry about --options + minor wording

											
										
										
											2016-09-29 13:12:23 +03:00
+								  ${chalk.gray('–')} Bakes '--expose-gc' into executable
-												readme: install, targets

											
										
										
											2016-10-06 11:03:44 +03:00
+								    ${chalk.cyan('$ pkg --options expose-gc index.js')}
-												--help

											
										
										
											2016-08-31 19:25:38 +03:00
 								`);
 								}