{"id":13762423,"url":"https://github.com/zowe/zowe-cli-sample-plugin","last_synced_at":"2025-10-27T02:31:51.925Z","repository":{"id":33348451,"uuid":"151723893","full_name":"zowe/zowe-cli-sample-plugin","owner":"zowe","description":"Plugin Tutorial for Zowe CLI","archived":false,"fork":false,"pushed_at":"2024-04-11T13:37:32.000Z","size":2151,"stargazers_count":9,"open_issues_count":2,"forks_count":15,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-11T15:07:35.971Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zowe.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-05T13:21:04.000Z","updated_at":"2024-06-20T01:57:11.025Z","dependencies_parsed_at":"2023-01-15T00:45:54.325Z","dependency_job_id":"21dcf278-5ab9-49a0-b274-5358c02aa9dd","html_url":"https://github.com/zowe/zowe-cli-sample-plugin","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-sample-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-sample-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-sample-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-sample-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zowe","download_url":"https://codeload.github.com/zowe/zowe-cli-sample-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238424080,"owners_count":19469977,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T14:00:42.345Z","updated_at":"2025-10-27T02:31:46.572Z","avatar_url":"https://github.com/zowe.png","language":"TypeScript","funding_links":[],"categories":["Uncategorized","others"],"sub_categories":["Uncategorized"],"readme":"# Zowe CLI Sample Plug-in\n\nThis 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.\n\n- [Zowe CLI Sample Plug-in](#zowe-cli-sample-plug-in)\n  - [Why Create a Zowe CLI Plug-in?](#why-create-a-zowe-cli-plug-in)\n  - [Tutorials, Documentation, and Guidelines](#tutorials-documentation-and-guidelines)\n    - [Tutorials](#tutorials)\n    - [Contribution Guidelines](#contribution-guidelines)\n    - [Imperative CLI Framework Documentation](#imperative-cli-framework-documentation)\n    - [Jenkinsfile Guidelines](#jenkinsfile-guidelines)\n  - [Prerequisites](#prerequisites)\n  - [Create a Local Development Space](#create-a-local-development-space)\n    - [Clone zowe-cli-sample-plugin and Build From Source](#clone-zowe-cli-sample-plugin-and-build-from-source)\n    - [Run the Automated Tests](#run-the-automated-tests)\n    - [Install the zowe-cli-sample-plugin to Zowe CLI](#install-the-zowe-cli-sample-plugin-to-zowe-cli)\n\n## Why Create a Zowe CLI Plug-in?\n\nYou might want to create a Zowe CLI plug-in to accomplish the following:\n\n* Provide new scriptable functionality for yourself, your organization, or to a broader community.\n* Make use of Zowe CLI infrastructure (profiles and programmatic APIs).\n* Participate in the Zowe CLI community space.\n\n## Tutorials, Documentation, and Guidelines\n\nWe also provide the following tutorials, guidelines, and documentation to assist you during development:\n\n### Tutorials\n\nTo 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](https://docs.zowe.org/stable/extend/extend-zowe-overview/#extend-zowe-cli).\n\n**Note:** For an advanced example on how to create a plug-in that serves as a Credential Manager, see [Zowe CLI secrets for Kubernetes](https://github.com/zowe/zowe-cli-secrets-for-kubernetes/)\n\n### Contribution Guidelines\n\nThe Zowe CLI [contribution guidelines](CONTRIBUTING.md) contain standards and conventions for developing Zowe CLI plug-ins.\n\nThe 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.\n\n### Imperative CLI Framework Documentation\n\n[Imperative CLI Framework](https://github.com/zowe/imperative/wiki) 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.\n\n### Jenkinsfile Guidelines\n\nReference the [Jenkinsfile Guidelines](CICD-TEMPLATE.md) for information about setting up and maintaining automated testing/deployment for your plug-in with Jenkins automation server.\n\n## Prerequisites\n\nBefore you work with the Zowe CLI sample plug-in, [install Zowe CLI globally.](https://docs.zowe.org/active-development/user-guide/cli-installcli.html)\n\n## Create a Local Development Space\n\nTo create your development space, clone and build the Zowe CLI sample plug-in from source.\n\nCreate a local development folder named `zowe-tutorial`. You will clone and build all projects in this folder.\n\nClone the repositories into your development folder to match the following structure:\n\n```\nzowe-tutorial\n└── zowe-cli-sample-plugin\n```\n\n### Clone zowe-cli-sample-plugin and Build From Source\n\nSee [setup](docs/tutorials/Setup.md).\n\n### Run the Automated Tests\n\n**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.\n\n1. `cd __tests__/__resources__/properties`\n2. Copy `example_properties.yaml` to `custom_properties.yaml`.\n3. Edit the properties within `custom_properties.yaml` to contain valid system information for your site.\n4. `cd` to your `zowe-cli-sample-plugin` folder\n5. `npm run test`\n\n### Install the zowe-cli-sample-plugin to Zowe CLI\n\nThis process assumes that you already installed Zowe CLI on your PC in the previous steps.\n\n1. `cd` to your `zowe-tutorial` folder.\n2. `zowe plugins install ./zowe-cli-sample-plugin`\n3. `zowe zowe-cli-sample`\n   You should see help text displayed if the installation was successful.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzowe%2Fzowe-cli-sample-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzowe%2Fzowe-cli-sample-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzowe%2Fzowe-cli-sample-plugin/lists"}