pkg/lib-es5/help.js

Package your Node.js project into an executable

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const chalk_1 = __importDefault(require("chalk"));
function help() {
    // eslint-disable-next-line no-console
    console.log(`
  ${chalk_1.default.bold('pkg')} [options] <input>

  ${chalk_1.default.dim('Options:')}

    -h, --help           output usage information
    -v, --version        output pkg version
    -t, --targets        comma-separated list of targets (see examples)
    -c, --config         package.json or any json file with top-level config
    --options            bake v8 options into executable to run with them on
    -o, --output         output file name or template for several files
    --out-path           path to save output one or more executables
    -d, --debug          show more information during packaging process [off]
    -b, --build          don't download prebuilt base binaries, build them
    --public             speed up and disclose the sources of top-level project
    --public-packages    force specified packages to be considered public
    --no-bytecode        skip bytecode generation and include source files as plain js
    -C, --compress       [default=None] compression algorithm = Brotli or GZip

  ${chalk_1.default.dim('Examples:')}

  ${chalk_1.default.gray('–')} Makes executables for Linux, macOS and Windows
    ${chalk_1.default.cyan('$ pkg index.js')}
  ${chalk_1.default.gray('–')} Takes package.json from cwd and follows 'bin' entry
    ${chalk_1.default.cyan('$ pkg .')}
  ${chalk_1.default.gray('–')} Makes executable for particular target machine
    ${chalk_1.default.cyan('$ pkg -t node14-win-arm64 index.js')}
  ${chalk_1.default.gray('–')} Makes executables for target machines of your choice
    ${chalk_1.default.cyan('$ pkg -t node12-linux,node14-linux,node14-win index.js')}
  ${chalk_1.default.gray('–')} Bakes '--expose-gc' and '--max-heap-size=34' into executable
    ${chalk_1.default.cyan('$ pkg --options "expose-gc,max-heap-size=34" index.js')}
  ${chalk_1.default.gray('–')} Consider packageA and packageB to be public
    ${chalk_1.default.cyan('$ pkg --public-packages "packageA,packageB" index.js')}
  ${chalk_1.default.gray('–')} Consider all packages to be public
    ${chalk_1.default.cyan('$ pkg --public-packages "*" index.js')}
  ${chalk_1.default.gray('–')} Bakes '--expose-gc' into executable
    ${chalk_1.default.cyan('$ pkg --options expose-gc index.js')}
  ${chalk_1.default.gray('–')} reduce size of the data packed inside the executable with GZip
    ${chalk_1.default.cyan('$ pkg --compress GZip index.js')}
`);
}
exports.default = help;
//# sourceMappingURL=help.js.map