Setting up your development environment
Before you follow the development tutorials for creating a Zowe™ CLI plug-in, follow these steps to set up your environment.
To create your development space, clone and build zowe-cli-sample-plugin from source.
Before you clone the repository, create a local development folder named
zowe-tutorial. You will clone and build all projects in this folder.
There are two branches in the repository that correspond to different Zowe CLI versions. You can develop two branches of your plug-in so that users can install your plug-in into
@zowe-v2-lts CLI. Developing for both versions will let you take advantage of new core features quickly and expose your plug-in to a wider range of users.
master branch of Sample Plug-in is compatible with the
@zowe-v2-lts version of core CLI (Zowe LTS release).
master branch of Sample Plug-in is also compatible with the
@latest version of core CLI (Zowe Active Development release) at this time.
For more information about the versioning scheme, see Maintainer Versioning in the Zowe CLI repository.
Clone zowe-cli-sample-plugin and build from source
Clone the repository into your development folder to match the following structure:
Follow these steps:
git clone https://github.com/zowe/zowe-cli-sample-plugin
git checkout master
npm run build
(Optional) Run the automated tests
We recommend running automated tests on all code changes. Follow these steps:
- Edit the properties within
custom_properties.yamlto contain valid system information for your site.
npm run test
After you complete your setup, follow the Installing the sample plug-in tutorial to install this sample plug-in to Zowe CLI.