11cb0ef41Sopenharmony_ci<!DOCTYPE html> 21cb0ef41Sopenharmony_ci<html lang="en"> 31cb0ef41Sopenharmony_ci<head> 41cb0ef41Sopenharmony_ci <meta charset="utf-8"> 51cb0ef41Sopenharmony_ci <meta name="viewport" content="width=device-width"> 61cb0ef41Sopenharmony_ci <meta name="nodejs.org:node-version" content="v18.20.1"> 71cb0ef41Sopenharmony_ci <title>Single executable applications | Node.js v18.20.1 Documentation</title> 81cb0ef41Sopenharmony_ci <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 91cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/style.css"> 101cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/hljs.css"> 111cb0ef41Sopenharmony_ci <link rel="canonical" href="https://nodejs.org/api/single-executable-applications.html"> 121cb0ef41Sopenharmony_ci <script async defer src="assets/api.js" type="text/javascript"></script> 131cb0ef41Sopenharmony_ci 141cb0ef41Sopenharmony_ci</head> 151cb0ef41Sopenharmony_ci<body class="alt apidoc" id="api-section-single-executable-applications"> 161cb0ef41Sopenharmony_ci <div id="content" class="clearfix"> 171cb0ef41Sopenharmony_ci <div id="column2" class="interior"> 181cb0ef41Sopenharmony_ci <div id="intro" class="interior"> 191cb0ef41Sopenharmony_ci <a href="/" title="Go back to the home page"> 201cb0ef41Sopenharmony_ci Node.js 211cb0ef41Sopenharmony_ci </a> 221cb0ef41Sopenharmony_ci </div> 231cb0ef41Sopenharmony_ci <ul> 241cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 251cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 261cb0ef41Sopenharmony_ci</ul> 271cb0ef41Sopenharmony_ci<hr class="line"> 281cb0ef41Sopenharmony_ci<ul> 291cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 301cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 311cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 321cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 331cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 341cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 351cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 361cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 371cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 381cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 391cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 401cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 411cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 421cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 431cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 441cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 451cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 461cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 471cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 481cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 491cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 501cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 511cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 521cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 531cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 541cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 551cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 561cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 571cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 581cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 591cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 601cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 611cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 621cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 631cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 641cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 651cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 661cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 671cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 681cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 691cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 701cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 711cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications active">Single executable applications</a></li> 721cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 731cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 741cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 751cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 761cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 771cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 781cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 791cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 801cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 811cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 821cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 831cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 841cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 851cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 861cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 871cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 881cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 891cb0ef41Sopenharmony_ci</ul> 901cb0ef41Sopenharmony_ci<hr class="line"> 911cb0ef41Sopenharmony_ci<ul> 921cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 931cb0ef41Sopenharmony_ci</ul> 941cb0ef41Sopenharmony_ci </div> 951cb0ef41Sopenharmony_ci 961cb0ef41Sopenharmony_ci <div id="column1" data-id="single-executable-applications" class="interior"> 971cb0ef41Sopenharmony_ci <header class="header"> 981cb0ef41Sopenharmony_ci <div class="header-container"> 991cb0ef41Sopenharmony_ci <h1>Node.js v18.20.1 documentation</h1> 1001cb0ef41Sopenharmony_ci <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 1011cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 1021cb0ef41Sopenharmony_ci <path fill="none" d="M0 0h24v24H0z" /> 1031cb0ef41Sopenharmony_ci <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 1041cb0ef41Sopenharmony_ci <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 1051cb0ef41Sopenharmony_ci </svg> 1061cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 1071cb0ef41Sopenharmony_ci <path d="M0 0h24v24H0z" fill="none" /> 1081cb0ef41Sopenharmony_ci <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 1091cb0ef41Sopenharmony_ci </svg> 1101cb0ef41Sopenharmony_ci </button> 1111cb0ef41Sopenharmony_ci </div> 1121cb0ef41Sopenharmony_ci <div id="gtoc"> 1131cb0ef41Sopenharmony_ci <ul> 1141cb0ef41Sopenharmony_ci <li class="pinned-header">Node.js v18.20.1</li> 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_ci <li class="picker-header"> 1171cb0ef41Sopenharmony_ci <a href="#"> 1181cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1191cb0ef41Sopenharmony_ci Table of contents 1201cb0ef41Sopenharmony_ci </a> 1211cb0ef41Sopenharmony_ci 1221cb0ef41Sopenharmony_ci <div class="picker"><div class="toc"><ul> 1231cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#single-executable-applications">Single executable applications</a></span> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#notes">Notes</a> 1261cb0ef41Sopenharmony_ci<ul> 1271cb0ef41Sopenharmony_ci<li><a href="#requireid-in-the-injected-module-is-not-file-based"><code>require(id)</code> in the injected module is not file based</a></li> 1281cb0ef41Sopenharmony_ci<li><a href="#__filename-and-modulefilename-in-the-injected-module"><code>__filename</code> and <code>module.filename</code> in the injected module</a></li> 1291cb0ef41Sopenharmony_ci<li><a href="#__dirname-in-the-injected-module"><code>__dirname</code> in the injected module</a></li> 1301cb0ef41Sopenharmony_ci<li><a href="#single-executable-application-creation-process">Single executable application creation process</a></li> 1311cb0ef41Sopenharmony_ci<li><a href="#platform-support">Platform support</a></li> 1321cb0ef41Sopenharmony_ci</ul> 1331cb0ef41Sopenharmony_ci</li> 1341cb0ef41Sopenharmony_ci</ul> 1351cb0ef41Sopenharmony_ci</li> 1361cb0ef41Sopenharmony_ci</ul></div></div> 1371cb0ef41Sopenharmony_ci </li> 1381cb0ef41Sopenharmony_ci 1391cb0ef41Sopenharmony_ci 1401cb0ef41Sopenharmony_ci <li class="picker-header"> 1411cb0ef41Sopenharmony_ci <a href="#"> 1421cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1431cb0ef41Sopenharmony_ci Index 1441cb0ef41Sopenharmony_ci </a> 1451cb0ef41Sopenharmony_ci 1461cb0ef41Sopenharmony_ci <div class="picker"><ul> 1471cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1481cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1491cb0ef41Sopenharmony_ci 1501cb0ef41Sopenharmony_ci <li> 1511cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1521cb0ef41Sopenharmony_ci </li> 1531cb0ef41Sopenharmony_ci </ul> 1541cb0ef41Sopenharmony_ci 1551cb0ef41Sopenharmony_ci<hr class="line"> 1561cb0ef41Sopenharmony_ci<ul> 1571cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1581cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1591cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1601cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1611cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1621cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1631cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1641cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1651cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1661cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1671cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1681cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1691cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1701cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1711cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1721cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1731cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1741cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1751cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1761cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1771cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1781cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications active">Single executable applications</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2131cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2141cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2151cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2161cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2171cb0ef41Sopenharmony_ci</ul> 2181cb0ef41Sopenharmony_ci<hr class="line"> 2191cb0ef41Sopenharmony_ci<ul> 2201cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2211cb0ef41Sopenharmony_ci</ul></div> 2221cb0ef41Sopenharmony_ci </li> 2231cb0ef41Sopenharmony_ci 2241cb0ef41Sopenharmony_ci 2251cb0ef41Sopenharmony_ci <li class="picker-header"> 2261cb0ef41Sopenharmony_ci <a href="#"> 2271cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2281cb0ef41Sopenharmony_ci Other versions 2291cb0ef41Sopenharmony_ci </a> 2301cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/single-executable-applications.html">21.x</a></li> 2311cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/single-executable-applications.html">20.x <b>LTS</b></a></li> 2321cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/single-executable-applications.html">19.x</a></li> 2331cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/single-executable-applications.html">18.x <b>LTS</b></a></li></ol></div> 2341cb0ef41Sopenharmony_ci </li> 2351cb0ef41Sopenharmony_ci 2361cb0ef41Sopenharmony_ci <li class="picker-header"> 2371cb0ef41Sopenharmony_ci <a href="#"> 2381cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2391cb0ef41Sopenharmony_ci Options 2401cb0ef41Sopenharmony_ci </a> 2411cb0ef41Sopenharmony_ci 2421cb0ef41Sopenharmony_ci <div class="picker"> 2431cb0ef41Sopenharmony_ci <ul> 2441cb0ef41Sopenharmony_ci <li> 2451cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2461cb0ef41Sopenharmony_ci </li> 2471cb0ef41Sopenharmony_ci <li> 2481cb0ef41Sopenharmony_ci <a href="single-executable-applications.json">View as JSON</a> 2491cb0ef41Sopenharmony_ci </li> 2501cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/single-executable-applications.md">Edit on GitHub</a></li> 2511cb0ef41Sopenharmony_ci </ul> 2521cb0ef41Sopenharmony_ci </div> 2531cb0ef41Sopenharmony_ci </li> 2541cb0ef41Sopenharmony_ci </ul> 2551cb0ef41Sopenharmony_ci </div> 2561cb0ef41Sopenharmony_ci <hr> 2571cb0ef41Sopenharmony_ci </header> 2581cb0ef41Sopenharmony_ci 2591cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2601cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#single-executable-applications">Single executable applications</a></span> 2611cb0ef41Sopenharmony_ci<ul> 2621cb0ef41Sopenharmony_ci<li><a href="#notes">Notes</a> 2631cb0ef41Sopenharmony_ci<ul> 2641cb0ef41Sopenharmony_ci<li><a href="#requireid-in-the-injected-module-is-not-file-based"><code>require(id)</code> in the injected module is not file based</a></li> 2651cb0ef41Sopenharmony_ci<li><a href="#__filename-and-modulefilename-in-the-injected-module"><code>__filename</code> and <code>module.filename</code> in the injected module</a></li> 2661cb0ef41Sopenharmony_ci<li><a href="#__dirname-in-the-injected-module"><code>__dirname</code> in the injected module</a></li> 2671cb0ef41Sopenharmony_ci<li><a href="#single-executable-application-creation-process">Single executable application creation process</a></li> 2681cb0ef41Sopenharmony_ci<li><a href="#platform-support">Platform support</a></li> 2691cb0ef41Sopenharmony_ci</ul> 2701cb0ef41Sopenharmony_ci</li> 2711cb0ef41Sopenharmony_ci</ul> 2721cb0ef41Sopenharmony_ci</li> 2731cb0ef41Sopenharmony_ci</ul></details> 2741cb0ef41Sopenharmony_ci 2751cb0ef41Sopenharmony_ci <div id="apicontent"> 2761cb0ef41Sopenharmony_ci <h2>Single executable applications<span><a class="mark" href="#single-executable-applications" id="single-executable-applications">#</a></span><a aria-hidden="true" class="legacy" id="single_executable_applications_single_executable_applications"></a></h2> 2771cb0ef41Sopenharmony_ci 2781cb0ef41Sopenharmony_ci<div class="api_metadata"> 2791cb0ef41Sopenharmony_ci<span>Added in: v19.7.0, v18.16.0</span> 2801cb0ef41Sopenharmony_ci</div> 2811cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_1"><a href="documentation.html#stability-index">Stability: 1</a> - Experimental: This feature is being designed and will change.</div><p></p> 2821cb0ef41Sopenharmony_ci<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/src/node_sea.cc">src/node_sea.cc</a></p> 2831cb0ef41Sopenharmony_ci<p>This feature allows the distribution of a Node.js application conveniently to a 2841cb0ef41Sopenharmony_cisystem that does not have Node.js installed.</p> 2851cb0ef41Sopenharmony_ci<p>Node.js supports the creation of <a href="https://github.com/nodejs/single-executable">single executable applications</a> by allowing 2861cb0ef41Sopenharmony_cithe injection of a JavaScript file into the <code>node</code> binary. During start up, the 2871cb0ef41Sopenharmony_ciprogram checks if anything has been injected. If the script is found, it 2881cb0ef41Sopenharmony_ciexecutes its contents. Otherwise Node.js operates as it normally does.</p> 2891cb0ef41Sopenharmony_ci<p>The single executable application feature only supports running a single 2901cb0ef41Sopenharmony_ciembedded <a href="modules.html#modules-commonjs-modules">CommonJS</a> file.</p> 2911cb0ef41Sopenharmony_ci<p>A bundled JavaScript file can be turned into a single executable application 2921cb0ef41Sopenharmony_ciwith any tool which can inject resources into the <code>node</code> binary.</p> 2931cb0ef41Sopenharmony_ci<p>Here are the steps for creating a single executable application using one such 2941cb0ef41Sopenharmony_citool, <a href="https://github.com/nodejs/postject">postject</a>:</p> 2951cb0ef41Sopenharmony_ci<ol> 2961cb0ef41Sopenharmony_ci<li> 2971cb0ef41Sopenharmony_ci<p>Create a JavaScript file:</p> 2981cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash"><span class="hljs-built_in">echo</span> <span class="hljs-string">'console.log(`Hello, ${process.argv[2]}!`);'</span> > hello.js</span></code> <button class="copy-button">copy</button></pre> 2991cb0ef41Sopenharmony_ci</li> 3001cb0ef41Sopenharmony_ci<li> 3011cb0ef41Sopenharmony_ci<p>Create a copy of the <code>node</code> executable and name it according to your needs:</p> 3021cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash"><span class="hljs-built_in">cp</span> $(<span class="hljs-built_in">command</span> -v node) hello</span></code> <button class="copy-button">copy</button></pre> 3031cb0ef41Sopenharmony_ci</li> 3041cb0ef41Sopenharmony_ci<li> 3051cb0ef41Sopenharmony_ci<p>Remove the signature of the binary:</p> 3061cb0ef41Sopenharmony_ci<ul> 3071cb0ef41Sopenharmony_ci<li>On macOS:</li> 3081cb0ef41Sopenharmony_ci</ul> 3091cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">codesign --remove-signature hello</span></code> <button class="copy-button">copy</button></pre> 3101cb0ef41Sopenharmony_ci<ul> 3111cb0ef41Sopenharmony_ci<li>On Windows (optional):</li> 3121cb0ef41Sopenharmony_ci</ul> 3131cb0ef41Sopenharmony_ci<p><a href="https://learn.microsoft.com/en-us/windows/win32/seccrypto/signtool">signtool</a> can be used from the installed <a href="https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/">Windows SDK</a>. If this step is 3141cb0ef41Sopenharmony_ciskipped, ignore any signature-related warning from postject.</p> 3151cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">signtool remove /s hello</span></code> <button class="copy-button">copy</button></pre> 3161cb0ef41Sopenharmony_ci</li> 3171cb0ef41Sopenharmony_ci<li> 3181cb0ef41Sopenharmony_ci<p>Inject the JavaScript file into the copied binary by running <code>postject</code> with 3191cb0ef41Sopenharmony_cithe following options:</p> 3201cb0ef41Sopenharmony_ci<ul> 3211cb0ef41Sopenharmony_ci<li><code>hello</code> - The name of the copy of the <code>node</code> executable created in step 2.</li> 3221cb0ef41Sopenharmony_ci<li><code>NODE_JS_CODE</code> - The name of the resource / note / section in the binary 3231cb0ef41Sopenharmony_ciwhere the contents of the JavaScript file will be stored.</li> 3241cb0ef41Sopenharmony_ci<li><code>hello.js</code> - The name of the JavaScript file created in step 1.</li> 3251cb0ef41Sopenharmony_ci<li><code>--sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2</code> - The 3261cb0ef41Sopenharmony_ci<a href="https://www.electronjs.org/docs/latest/tutorial/fuses">fuse</a> used by the Node.js project to detect if a file has been injected.</li> 3271cb0ef41Sopenharmony_ci<li><code>--macho-segment-name NODE_JS</code> (only needed on macOS) - The name of the 3281cb0ef41Sopenharmony_cisegment in the binary where the contents of the JavaScript file will be 3291cb0ef41Sopenharmony_cistored.</li> 3301cb0ef41Sopenharmony_ci</ul> 3311cb0ef41Sopenharmony_ci<p>To summarize, here is the required command for each platform:</p> 3321cb0ef41Sopenharmony_ci<ul> 3331cb0ef41Sopenharmony_ci<li> 3341cb0ef41Sopenharmony_ci<p>On systems other than macOS:</p> 3351cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">npx postject hello NODE_JS_CODE hello.js \ 3361cb0ef41Sopenharmony_ci --sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2</span></code> <button class="copy-button">copy</button></pre> 3371cb0ef41Sopenharmony_ci</li> 3381cb0ef41Sopenharmony_ci<li> 3391cb0ef41Sopenharmony_ci<p>On macOS:</p> 3401cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">npx postject hello NODE_JS_CODE hello.js \ 3411cb0ef41Sopenharmony_ci --sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2 \ 3421cb0ef41Sopenharmony_ci --macho-segment-name NODE_JS</span></code> <button class="copy-button">copy</button></pre> 3431cb0ef41Sopenharmony_ci</li> 3441cb0ef41Sopenharmony_ci</ul> 3451cb0ef41Sopenharmony_ci</li> 3461cb0ef41Sopenharmony_ci<li> 3471cb0ef41Sopenharmony_ci<p>Sign the binary:</p> 3481cb0ef41Sopenharmony_ci<ul> 3491cb0ef41Sopenharmony_ci<li>On macOS:</li> 3501cb0ef41Sopenharmony_ci</ul> 3511cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">codesign --sign - hello</span></code> <button class="copy-button">copy</button></pre> 3521cb0ef41Sopenharmony_ci<ul> 3531cb0ef41Sopenharmony_ci<li>On Windows (optional):</li> 3541cb0ef41Sopenharmony_ci</ul> 3551cb0ef41Sopenharmony_ci<p>A certificate needs to be present for this to work. However, the unsigned 3561cb0ef41Sopenharmony_cibinary would still be runnable.</p> 3571cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">signtool sign /fd SHA256 hello</span></code> <button class="copy-button">copy</button></pre> 3581cb0ef41Sopenharmony_ci</li> 3591cb0ef41Sopenharmony_ci<li> 3601cb0ef41Sopenharmony_ci<p>Run the binary:</p> 3611cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">./hello world</span> 3621cb0ef41Sopenharmony_ciHello, world!</code> <button class="copy-button">copy</button></pre> 3631cb0ef41Sopenharmony_ci</li> 3641cb0ef41Sopenharmony_ci</ol> 3651cb0ef41Sopenharmony_ci<section><h3>Notes<span><a class="mark" href="#notes" id="notes">#</a></span><a aria-hidden="true" class="legacy" id="single_executable_applications_notes"></a></h3> 3661cb0ef41Sopenharmony_ci<h4><code>require(id)</code> in the injected module is not file based<span><a class="mark" href="#requireid-in-the-injected-module-is-not-file-based" id="requireid-in-the-injected-module-is-not-file-based">#</a></span><a aria-hidden="true" class="legacy" id="single_executable_applications_require_id_in_the_injected_module_is_not_file_based"></a></h4> 3671cb0ef41Sopenharmony_ci<p><code>require()</code> in the injected module is not the same as the <a href="modules.html#requireid"><code>require()</code></a> 3681cb0ef41Sopenharmony_ciavailable to modules that are not injected. It also does not have any of the 3691cb0ef41Sopenharmony_ciproperties that non-injected <a href="modules.html#requireid"><code>require()</code></a> has except <a href="modules.html#accessing-the-main-module"><code>require.main</code></a>. It 3701cb0ef41Sopenharmony_cican only be used to load built-in modules. Attempting to load a module that can 3711cb0ef41Sopenharmony_cionly be found in the file system will throw an error.</p> 3721cb0ef41Sopenharmony_ci<p>Instead of relying on a file based <code>require()</code>, users can bundle their 3731cb0ef41Sopenharmony_ciapplication into a standalone JavaScript file to inject into the executable. 3741cb0ef41Sopenharmony_ciThis also ensures a more deterministic dependency graph.</p> 3751cb0ef41Sopenharmony_ci<p>However, if a file based <code>require()</code> is still needed, that can also be achieved:</p> 3761cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> { createRequire } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:module'</span>); 3771cb0ef41Sopenharmony_ci<span class="hljs-built_in">require</span> = <span class="hljs-title function_">createRequire</span>(__filename);</code> <button class="copy-button">copy</button></pre> 3781cb0ef41Sopenharmony_ci<h4><code>__filename</code> and <code>module.filename</code> in the injected module<span><a class="mark" href="#__filename-and-modulefilename-in-the-injected-module" id="__filename-and-modulefilename-in-the-injected-module">#</a></span><a aria-hidden="true" class="legacy" id="single_executable_applications_filename_and_module_filename_in_the_injected_module"></a></h4> 3791cb0ef41Sopenharmony_ci<p>The values of <code>__filename</code> and <code>module.filename</code> in the injected module are 3801cb0ef41Sopenharmony_ciequal to <a href="process.html#processexecpath"><code>process.execPath</code></a>.</p> 3811cb0ef41Sopenharmony_ci<h4><code>__dirname</code> in the injected module<span><a class="mark" href="#__dirname-in-the-injected-module" id="__dirname-in-the-injected-module">#</a></span><a aria-hidden="true" class="legacy" id="single_executable_applications_dirname_in_the_injected_module"></a></h4> 3821cb0ef41Sopenharmony_ci<p>The value of <code>__dirname</code> in the injected module is equal to the directory name 3831cb0ef41Sopenharmony_ciof <a href="process.html#processexecpath"><code>process.execPath</code></a>.</p> 3841cb0ef41Sopenharmony_ci<h4>Single executable application creation process<span><a class="mark" href="#single-executable-application-creation-process" id="single-executable-application-creation-process">#</a></span><a aria-hidden="true" class="legacy" id="single_executable_applications_single_executable_application_creation_process"></a></h4> 3851cb0ef41Sopenharmony_ci<p>A tool aiming to create a single executable Node.js application must 3861cb0ef41Sopenharmony_ciinject the contents of a JavaScript file into:</p> 3871cb0ef41Sopenharmony_ci<ul> 3881cb0ef41Sopenharmony_ci<li>a resource named <code>NODE_JS_CODE</code> if the <code>node</code> binary is a <a href="https://en.wikipedia.org/wiki/Portable_Executable">PE</a> file</li> 3891cb0ef41Sopenharmony_ci<li>a section named <code>NODE_JS_CODE</code> in the <code>NODE_JS</code> segment if the <code>node</code> binary 3901cb0ef41Sopenharmony_ciis a <a href="https://en.wikipedia.org/wiki/Mach-O">Mach-O</a> file</li> 3911cb0ef41Sopenharmony_ci<li>a note named <code>NODE_JS_CODE</code> if the <code>node</code> binary is an <a href="https://en.wikipedia.org/wiki/Executable_and_Linkable_Format">ELF</a> file</li> 3921cb0ef41Sopenharmony_ci</ul> 3931cb0ef41Sopenharmony_ci<p>Search the binary for the 3941cb0ef41Sopenharmony_ci<code>NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2:0</code> <a href="https://www.electronjs.org/docs/latest/tutorial/fuses">fuse</a> string and flip the 3951cb0ef41Sopenharmony_cilast character to <code>1</code> to indicate that a resource has been injected.</p> 3961cb0ef41Sopenharmony_ci<h4>Platform support<span><a class="mark" href="#platform-support" id="platform-support">#</a></span><a aria-hidden="true" class="legacy" id="single_executable_applications_platform_support"></a></h4> 3971cb0ef41Sopenharmony_ci<p>Single-executable support is tested regularly on CI only on the following 3981cb0ef41Sopenharmony_ciplatforms:</p> 3991cb0ef41Sopenharmony_ci<ul> 4001cb0ef41Sopenharmony_ci<li>Windows</li> 4011cb0ef41Sopenharmony_ci<li>macOS</li> 4021cb0ef41Sopenharmony_ci<li>Linux (all distributions <a href="https://github.com/nodejs/node/blob/main/BUILDING.md#platform-list">supported by Node.js</a> except Alpine and all 4031cb0ef41Sopenharmony_ciarchitectures <a href="https://github.com/nodejs/node/blob/main/BUILDING.md#platform-list">supported by Node.js</a> except s390x and ppc64)</li> 4041cb0ef41Sopenharmony_ci</ul> 4051cb0ef41Sopenharmony_ci<p>This is due to a lack of better tools to generate single-executables that can be 4061cb0ef41Sopenharmony_ciused to test this feature on other platforms.</p> 4071cb0ef41Sopenharmony_ci<p>Suggestions for other resource injection tools/workflows are welcomed. Please 4081cb0ef41Sopenharmony_cistart a discussion at <a href="https://github.com/nodejs/single-executable/discussions">https://github.com/nodejs/single-executable/discussions</a> 4091cb0ef41Sopenharmony_cito help us document them.</p></section> 4101cb0ef41Sopenharmony_ci <!-- API END --> 4111cb0ef41Sopenharmony_ci </div> 4121cb0ef41Sopenharmony_ci </div> 4131cb0ef41Sopenharmony_ci </div> 4141cb0ef41Sopenharmony_ci</body> 4151cb0ef41Sopenharmony_ci</html> 416