Installing and configuring the PAX edition

Hardware prerequisites

The requirements for installing IBM® SDK for Node.js - z/OS® 14.0 are listed below.

  • z15™
  • z14®/z14 Model ZR1
  • z13®/z13s®
  • zEnterprise® EC12/BC12

Software prerequisites

  • z/OS UNIX System Services enabled on any of following operating systems:
  • Integrated Cryptographic Services Facility (ICSF) must be enabled on systems where IBM SDK for Node.js - z/OS is run. For details, refer to ICSF System Programmer's Guide (SC14-7507) and ICSF Administrator's Guide (SC14-7506).
  • Python 3.8.2 or later 3.x versions, required to compile native add-ons. It must also be defined in your PATH environment variable.
  • Make 4.1 or later, required to compile native add-ons. It must also be defined in your PATH environment variable.
  • If you use the bash shell, make sure you use Rocket bash because the default bash shell that ships with the operating system is known to have auto-conversion issues. The Rocket bash is available for download at Bash for z/OS on the Rocket website.

Storage requirements

The PAX archive installable file contains an updated C/C++ runtime and compiler, which has the following storage requirements:
  • 2 GB free space on HFS.
  • 400 MB free space for the MVS™ dataset under the high-level qualifier (HLQ) where the compiler will be installed. The default HLQ will be your user ID.


IBM SDK for Node.js - z/OS is an OMVS-based application, which requires certain configuration on the z/OS UNIX System Services file system to ensure proper operation.
  • Validate that /usr/bin/env exists. If not configured, refer to the instructions in Verifying the env command path.
  • Ensure that /tmp has at least 1 GB or more of disk space configured. To use an alternative file system, you can set the TMPDIR environment variable to a directory that has sufficient space.


Follow these steps to install IBM SDK for Node.js - z/OS:
  1. Download the PAX archive installable file to a z/OS machine.
  2. Unpax the downloaded pax file using the following command:
    $ pax -p p -r -f <downloaded_pax_file>
    This command creates the installation directory <nodejs_dir> under <nodejs_pax_dir>.
  3. Run to validate system prerequisites, setup environment variables, and optionally install the njsc C/C++ compiler:
    $ cd <nodejs_dir>
    $ ./
  4. In order for Node.js to operate correctly, specific environment variables must be set. Run the .nodeenv script generated by to set the required environment variables in the current shell using the dot command (.):
    $ . <nodejs_dir>/.nodeenv
    This command also adds <nodejs_dir>/bin to your PATH, where the node binary is located.
  5. Run the node and npm commands from the command line.


To uninstall IBM SDK for Node.js - z/OS 14.0, delete the installation directory.

Related reference

Node.js v14 API reference documentation