{"id":25257241,"url":"https://github.com/zowe/zowe-cli-web-help-generator","last_synced_at":"2025-10-27T02:31:44.047Z","repository":{"id":40297256,"uuid":"423588810","full_name":"zowe/zowe-cli-web-help-generator","owner":"zowe","description":"This repository enables conformant plug-ins to contribute their web help to our Zowe Docs Site.","archived":false,"fork":false,"pushed_at":"2025-10-16T15:38:19.000Z","size":4772,"stargazers_count":4,"open_issues_count":0,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-10-17T17:48:04.723Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zowe.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-01T19:21:04.000Z","updated_at":"2025-10-16T15:35:51.000Z","dependencies_parsed_at":"2024-05-28T15:20:12.853Z","dependency_job_id":"dc44f9e6-4ee4-4aa2-9db0-0ff801eb0b12","html_url":"https://github.com/zowe/zowe-cli-web-help-generator","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/zowe/zowe-cli-web-help-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-web-help-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-web-help-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-web-help-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-web-help-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zowe","download_url":"https://codeload.github.com/zowe/zowe-cli-web-help-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-cli-web-help-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281203447,"owners_count":26460841,"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","status":"online","status_checked_at":"2025-10-27T02:00:05.855Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-02-12T06:38:25.878Z","updated_at":"2025-10-27T02:31:43.453Z","avatar_url":"https://github.com/zowe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zowe CLI Web Help Generator\n\n## About the Generator\n\nThis repository introduces utilities that extract the command tree from the CLI and its installed plug-ins, store the relevant command groups for third party conformant plug-ins in a legal-approved way (without exposing proprietary code), and generate web help with those plug-ins included on demand.\n\nTo contribute your plug-in's web help, follow the steps below for installing and using the project.\n\n---\n\n## Installing\n\n1. Clone this repository from GitHub:\n    ```bash\n    git clone https://github.com/zowe/zowe-cli-web-help-generator.git\n    cd zowe-cli-web-help-generator\n    ```\n\n2. Install project dependencies:\n    ```bash\n    npm install --prod\n    ```\n    \u003e **Note:** If you plan to modify the scripts in this repo, omit the `--prod` flag to also install dev dependencies.\n\n3. Install the plug-in you want to contribute into Zowe CLI, if it is not already installed. If you do not have a globally installed Zowe CLI available, run:\n    ```bash\n    npx zowe plugins install \u003cplugin name or path here\u003e\n    ```\n\n---\n\n## Contributing to the web help\n\nTo add your conformant plug-in's commands, perform the following steps:\n\u003e **Note:** All steps should be performed in the root of this project.\n\n1. Ensure the plug-in you want to contribute to the web help is installed in Zowe CLI.\n\n    If it is not already installed, see Step 3 in the [Installing](#installing) section.\n\n2. Define command groups that your plug-in contributes.\n\n    - Copy the template file `zowe.template.json` to a new file named `zowe.json`. This file will be ignored by git.\n    - Customize this file to include the full names of command group(s) of your plug-in(s), like the following:\n        ```json\n        {\n          \"commandGroups\": [\"zowe-cli-sample\"]\n        }\n        ```\n    \u003e **Note:** No @zowe scoped plug-ins should be included in this repository, and the above is merely for demonstration purposes.\n\n3. (Optional) Include your copyright notice, which will show as a comment in the generated output.\n\n    Create a file named `.copyright` and add your copyright notice there. This file will be ignored by git. If no copyright is supplied, the following default copyright will be added:\n    ```\n    Copyright Contributors to the Zowe Project.\n    ```\n\n4. Use the web help generator to extract help from your plug-in's command definitions.\n\n    Run the following command:\n    ```bash\n    npm run contribute\n    ```\n    This will retrieve the CLI command tree from Zowe CLI and all installed plug-ins, and extract the above command group(s) to `.jsonc` files in the \"commandGroups\" directory.\n\n5. Commit new files back to the GitHub repository.\n\n    - Commit the newly created `.jsonc` files to git. Ensure the commit is signed off (it must include a \"Signed-off-by\" line).\n        ```bash\n        git commit -s -m \"Add \u003cplugin name\u003e plug-in\"\n        ```\n    - Create a pull request in this repository that contributes the new files so that your plug-in will be included in web help for the next Zowe release.\n\n---\n\n## Generating the web help\n\nTo preview web help with your plug-in included locally, perform the following steps:\n\n1. Ensure the latest CLI and plug-ins are installed to generate up-to-date help.\n\n    Install the latest version of Zowe CLI, and all @zowe scoped plug-ins (CICS, DB2, FTP, and MQ for Zowe v2) if they are not already installed. If you do not have a globally installed Zowe CLI available, the CLI can also be accessed in this repository by running `npx zowe`.\n\n2. Build web help that includes all plug-ins contributed to this repository.\n\n    In the root of this project, run:\n    ```bash\n    npm run build\n    ```\n    This will generate the CLI command tree from the CLI and @zowe packages, merge all of the command groups in the defined folders, and generate the web help in the \"generatedWebHelp\" directory.\n\n3. Open the file \"generatedWebHelp/index.html\" in your browser to view the generated web help.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzowe%2Fzowe-cli-web-help-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzowe%2Fzowe-cli-web-help-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzowe%2Fzowe-cli-web-help-generator/lists"}