Skip to main content
Version: v3.0.x LTS

Zowe CLI installation checklist

Zowe CLI installation checklist

This checklist outlines the required steps for a first-time installation of Zowe CLI.

Required roles: systems administrator, devops architect, security administrator, systems programmer

The checklist includes a brief description of the steps required for installation of Zowe CLI. The checklist also identifies the roles that are typically required to complete the step, which enables the pre-installation planning team to focus on the tasks for which they are responsible.

For a printable version of this checklist, click here.

Preparing for installation

StepDescriptionRoleTime Estimate
Addressing Zowe CLI software requirements and Zowe CLI plug-ins software requirementsCheck the following items:
  • Node.js
  • Node Package Manager (npm)
  • Disk space
  • Plug-in configuration
Systems administrator15 min.
Configuring your PC to install from an online registry by proxyConfigure log-in credential requirements in the NPM configuration file to use a proxy server to download Zowe CLI.Systems administrator15 min.
Configuring z/OSMFConfirm that z/OS components, region sizes, and user IDs meet Zowe CLI requirements.Systems programmer40 min.
Configuring z/OSMF securityConfigure security for:
  • SAF access to REST endpoints
  • z/OS console REST interface
  • z/OS data set and file REST services
Security administrator50 min.

Installing Zowe CLI and Zowe CLI plug-ins

StepDescriptionRoleTime Estimate
Installing Zowe CLI and Zowe CLI plug-ins from a local package or
an NPM public online registry
Install Zowe CLI from an online registry or a local package.Systems administrator30 min.
Updating Zowe CLI and Zowe CLI plug-insIdentify the currently installed version of Zowe CLI and update to the most recent version. Or, revert to a specific previous release of Zowe CLI.Systems administrator30 min.

Configuring Zowe CLI

StepDescriptionRoleTime Estimate
Configuring Zowe CLI environment variablesSet the location of the CLI home directory to contain log files, profiles, and other files.

Set log levels to adjust the detail included in log files.

Set CLI daemon mode properties.
Security administrator and/or
DevOps architect
15 min.
Initializing team configurationCreate team profiles to streamline profile management in one location:

  • Create service profiles to store connection information for a specific mainframe service.
  • Create base profiles to store connection information used with one or more services.
Security administrator and/or
DevOps architect
15 min.
Configuring daemon modeEnable daemon mode and configure daemon mode properties to run Zowe CLI commands significantly faster.Security administrator and/or
DevOps architect
15 min
Verifying your Zowe CLI installationConfirm the connection to z/OSMF.
Access the product help.
Systems administrator and/or
DevOps architect
15 min.