Zowe CLI

The resources here provide information about various Zowe CLI topics, such as learning basic skills, installation, developing, and troubleshooting.

tip

To identify the resources most relevant for you, use the following definitions of Zowe CLI skill levels.

• Beginner: You're starting out and want to learn the fundamentals.
• Intermediate: You have some experience but want to learn more in-depth skills.
• Advanced: You have lots of experience and are looking to learn about specialized topics.

Fundamentals

Zowe skill level: Beginner

• Zowe CLI overview

  New to Zowe CLI? This overview topic introduces what is Zowe CLI.

• Architecture

  Review the Zowe architecture to understand how Zowe CLI works in the Zowe framework.

• Zowe CLI FAQs

  If you have a question, it's a good idea to try the FAQ, which answers the most commonly asked questions about Zowe CLI.

Quick start

Zowe skill level: Beginner

• Zowe CLI quick start

  Get started with Zowe CLI quickly and easily.

• Blog: Getting Started with Zowe CLI

  This blog enables you to get started with Zowe CLI quickly.

Installing

Zowe skill level: Beginner

• System requirements

  Review this topic to ensure that your system meets the requirements for installing Zowe CLI.

• Installing Zowe CLI

  Follow the steps to install a new release of Zowe CLI.

Configuring and updating

Zowe skill level: Intermediate

• Configuring Zowe CLI environment variables

  Explains how to configure Zowe CLI environment variables, such as changing log levels, setting the home directory location, and daemon mode.

• Updating Zowe CLI

  Learn how to update Zowe CLI to a more recent version using different methods.

Using Zowe CLI and plug-ins

Zowe skill level: Intermediate

• Using Zowe CLI

  Learn about how to use Zowe CLI, including connecting to the mainframe, managing profiles, integrating with API Mediation Layer, and more.

• Zowe CLI extensions and plug-ins

  This information guides you to explore the extensions and plug-ins available to Zowe CLI and install plug-ins to extend the capabilities of Zowe CLI. Plug-ins add functionality to the product in the form of new command groups, actions, objects, and options.

• Docs: Zowe CLI command reference guide

  View detailed documentation on commands, actions, and options in Zowe CLI. The reference document is based on the @zowe-v2-lts version of the CLI.

  The content also contains the web help for all Zowe ecosystem-conformant plug-ins that contributed to this website.

  You can read an interactive online version, download a PDF document, or download a ZIP file containing the HTML for the online version:

  • Browse online
  • Download CLI reference in PDF format
  • Download CLI reference in ZIP format

• Best practices

  Are you looking for recommendations and tips on how to best use Zowe CLI to meet your needs? These resources provide best practices recommendations.

  • Blog: Zowe CLI Tips & Tricks

• Zowe CLI and TSO commands

  This blog shows how to configure and use the TSO command feature of Zowe.

Developing a Zowe CLI plug-in

Zowe skill level: Advanced

Zowe CLI extenders can build plug-ins that provide new commands.

• Developing for the CLI

  Learn about developing for Zowe CLI.

• Zowe CLI core repository

  If you want to start working with the code immediately, check out this code repository.

• Tutorials

  Follow these tutorials to get started working with a sample plug-in.

Contributing to Zowe CLI

Zowe skill level: Advanced

• Contributing guidelines

  This document is a summary of conventions and best practices for development within Zowe CLI or development of Zowe CLI plug-ins. The guidelines contain critical information about working with the code, running, writing, and maintaining automated tests, developing consistent syntax in your plug-in, and ensuring that your plug-in integrates with Zowe CLI properly.

• Conformance Program

  This topic introduces the Zowe Conformance Program. Conformance provides Independent Software Vendors (ISVs), System Integrators (SIs), and end users greater confidence that their software will behave as expected. As vendors, you are invited to submit conformance testing results for review and approval by the Open Mainframe Project. If your company provides software based on Zowe CLI, you are encouraged to get certified today.

• Blog: Zowe Conformance Program Explained

  This blog describes the Conformance Program in more details.

Troubleshooting and support

• Troubleshooting Zowe CLI

  Learn about the tools and techniques that are available to help you troubleshoot and resolve problems. You can also find a list of common issues about Zowe CLI.

• Submit an issue

  If you have an issue that is specific to Zowe CLI, you can submit an issue against the zowe-cli repository on GitHub.

Community resources

• Slack channel

  Join the #zowe-cli Slack channel to ask questions about Zowe CLI, propose new ideas, and interact with the Zowe community.

• Zowe CLI squad meetings

  Join Zowe CLI squad meetings to get involved.

• Zowe CLI Blogs on Medium

  Read a series of blogs about Zowe CLI on Medium to explore use cases, best practices, and more.

• Community Forums

  Look for discussion on Zowe topics on the Open Mainframe Project Community Forums.