Question 1

How to package a Node.js app with pkg for multiple platforms?

Accepted Answer

Use the -t flag with comma-separated targets, e.g., 'pkg -t node16-linux,node18-win index.js'. Ensure dependencies and assets are listed in the pkg config in package.json to avoid missing files.

Question 2

pkg vs nexe: which is better for creating Node.js executables?

Accepted Answer

pkg offers more features like cross-compilation and asset embedding, but is deprecated. nexe is simpler and actively maintained but may lack advanced capabilities. For new projects, consider Node.js's built-in single executable applications.

Question 3

How to handle dynamic requires in pkg?

Accepted Answer

Manually specify files in the 'scripts' or 'assets' field of the pkg config in package.json, as pkg cannot automatically detect non-literal require calls like 'require('./' + variable + '.js')'.

Question 4

Is pkg still supported or maintained?

Accepted Answer

No, pkg was deprecated with version 5.8.1 as the final release. The repository is archived, and users are directed to forked versions or Node.js's native single executable application feature.

Question 5

Can pkg protect my Node.js source code from being read?

Accepted Answer

Yes, by default, pkg compiles source to bytecode, which obscures code. However, using --no-bytecode exposes raw source in the executable, and bytecode is not fully secure against reverse engineering.

Question 6

How to reduce the size of pkg executables?

Accepted Answer

Use the --compress option with Brotli or GZip to compress embedded files, reducing size by up to 60% as noted in the README, though it may slightly impact startup time.

pkg

What is pkg?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions