This repository contains a sample Zowe CLI plug-in that adheres to the contribution guidelines for the project. Use this project and the associated tutorials as a starting point for creating Zowe CLI plug-ins.
- Zowe CLI Sample Plug-in
You might want to create a Zowe CLI plug-in to accomplish the following:
- Provide new scriptable functionality for yourself, your organization, or to a broader community.
- Make use of Zowe CLI infrastructure (profiles and programmatic APIs).
- Participate in the Zowe CLI community space.
We also provide the following tutorials, guidelines, and documentation to assist you during development:
To learn about how to work with this sample plug-in, build new commands, or build a new Zowe CLI plug-in, see Extend Zowe CLI.
Note: For an advanced example on how to create a plug-in that serves as a Credential Manager, see Zowe CLI secrets for Kubernetes
The Zowe CLI contribution guidelines contain standards and conventions for developing Zowe CLI plug-ins.
The guidelines contain critical information about working with the code, running/writing/maintaining automated tests, developing consistent syntax in your plug-in, and ensuring that your plug-in integrates with Zowe CLI properly.
Imperative CLI Framework documentation is a key source of information to learn about the features of Imperative CLI Framework (the code framework that you use to build plug-ins for Zowe CLI). Refer to these documents during development.
Reference the Jenkinsfile Guidelines for information about setting up and maintaining automated testing/deployment for your plug-in with Jenkins automation server.
Before you work with the Zowe CLI sample plug-in, install Zowe CLI globally.
To create your development space, clone and build the Zowe CLI sample plug-in from source.
Create a local development folder named zowe-tutorial
. You will clone and build all projects in this folder.
Clone the repositories into your development folder to match the following structure:
zowe-tutorial
└── zowe-cli-sample-plugin
See setup.
Note: If you don't have access to a z/OSMF instance at your site, run npm run server:start
to launch a mock server at http://localhost:3000.
cd __tests__/__resources__/properties
- Copy
example_properties.yaml
tocustom_properties.yaml
. - Edit the properties within
custom_properties.yaml
to contain valid system information for your site. cd
to yourzowe-cli-sample-plugin
foldernpm run test
This process assumes that you already installed Zowe CLI on your PC in the previous steps.
cd
to yourzowe-tutorial
folder.zowe plugins install ./zowe-cli-sample-plugin
zowe zowe-cli-sample
You should see help text displayed if the installation was successful.