{"id":25257281,"url":"https://github.com/zowe/zowe-chat","last_synced_at":"2025-10-27T02:31:52.663Z","repository":{"id":37476748,"uuid":"481718102","full_name":"zowe/zowe-chat","owner":"zowe","description":"Zowe Chat Ops","archived":false,"fork":false,"pushed_at":"2023-08-10T15:54:43.000Z","size":57190,"stargazers_count":5,"open_issues_count":48,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2023-08-10T20:38:42.649Z","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":"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}},"created_at":"2022-04-14T19:00:13.000Z","updated_at":"2023-08-10T20:38:42.650Z","dependencies_parsed_at":"2023-02-14T10:15:47.130Z","dependency_job_id":null,"html_url":"https://github.com/zowe/zowe-chat","commit_stats":null,"previous_names":[],"tags_count":2,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zowe%2Fzowe-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zowe","download_url":"https://codeload.github.com/zowe/zowe-chat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238424101,"owners_count":19469982,"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":"2025-02-12T06:38:43.650Z","updated_at":"2025-10-27T02:31:52.658Z","avatar_url":"https://github.com/zowe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notice\n\nThis repository is archived and read-only. If you are interested in this project or have a use-case you would like to discuss, open an issue in the [community repository](https://github.com/zowe/community/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen).\n\n# Zowe Chat\n\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/zowe/zowe-chat/badge)](https://api.securityscorecards.dev/projects/github.com/zowe/zowe-chat)\n[![Zowe Chat CI Build](https://github.com/zowe/zowe-chat/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/zowe/zowe-chat/actions/workflows/ci.yml)\n\nZowe Chat is a chatting application for you to operate z/OS itself including job, dataset, USS file, error code, console command etc. from channels of 3 popular chat tools including Mattermost, Slack, Microsoft Teams. Extendibility also is provided for users to create their own plugins to extend capabilities of Zowe Chat as plugins.\n\n## Content\n\n- [Features](#features)\n- [Projects](#projects)\n- [Documentation](#documentation)\n- [Contribution guidelines](#contribution-guidelines)\n- [Steps to build Zowe Chat](#steps-to-build-zowe-chat)\n- [Steps to run Zowe Chat server](#steps-to-run-zowe-chat-server)\n\n## Features\n\n- Operate z/OS job\n- Operate z/OS dataset\n- Operate z/OS USS file\n- Query z/OS error code\n- Issue z/OS console command\n- Extendibility with plugin\n\n## Projects\n\nThere are four projects below under Zowe Chat repository.\n\n- [@zowe/chat](https://github.com/zowe/zowe-chat/blob/main/packages/chat/README.md)\n- [@zowe/zos](https://github.com/zowe/zowe-chat/blob/main/packages/zos/README.md)\n- [@zowe/clicmd](https://github.com/zowe/zowe-chat/blob/main/packages/clicmd/README.md)\n- [@zowe/webapp](https://github.com/zowe/zowe-chat/blob/main/packages/webapp/README.md)\n\n## Documentation\n\nFor detailed information about how to install, configure, and use Zowe Chat, see [Zowe Chat Documentation](https://TBD/).\n\n## Contribution guidelines\n\nThe following information is critical to 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| For more information about ...                                        | See:                                                                                                   |\n| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| General guidelines that apply to contributing to Zowe Chat            | [Contribution Guidelines](./CONTRIBUTING.md)                                                           |\n| Documentation that describes the features of the Common Bot Framework | [About Common Bot Framework](https://github.com/zowe/zowe-chat/blob/main/packages/commonbot/README.md) |\n\n## Steps to build Zowe Chat\n\n- Environment variables\n\n  - NODE_ENV\n\n    Specifies the building environment for your mono-repo\n\n  - RELEASE_TYPE\n\n    Specifies the release type of your building result\n\n  - RELEASE_VERSION\n\n    Specifies the release version of your building result\n\n- Build steps\n  - Clone the repo\n  - Go to the directory where Zowe Chat repo is cloned\n  - Run the command below to build the whole workspaces\n    ```sh\n    npm run installAll\n    npm run buildAll\n    ```\n    \u003e **Note:** You can also to build single project by specifying the detailed project name. e.g. use the command `npm run build --workspace=@zowe/chat` to build only `chat` project.\n\n## Steps to run Zowe Chat server\n\n- **Prerequisite:** the connection with your chat tool and related bot app are ready\n- **Run from local laptop for development**\n\n  \u003e **Note:** Depending on chat tool requirement and your laptop network environment, not all chat clients will work when running the project locally (i.e. MSTeams)\n\n  - Execute `npm run buildAll` to build all projects\n  - Execute `npm run startLocal` to set up a local environment in the folder `$PROJECT_ROOT/.build` based on the previous build result\n    \u003e **Note:** This will fail on first invocation.\n  - Configure your local environment in the `$PROJECT_ROOT/.build/zoweChat/config` folder\n  - Re-execute `npm run startLocal` command to start Zowe Chat server locally\n    \u003e **Note:** This will not over-write changes to your configuration\n  - Launch your chat tool client and chat with your bot\n\n- **Run from your xLinux or zLinux server for production**\n  - Execute `npm run packagingAll` to build and package the project\n    \u003e **Note:** Your must set the three required environment variables (`NODE_ENV`, `RELEASE_TYPE`, `RELEASE_VERSION`) for packaging first\n  - Upload your building result `$PROJECT_ROOT/release/zowe-chat-v\u003cversion\u003e-.tar.gz` to your Linux server\n  - Logon your Linux server, create one folder and unpack the building result there\n  - Set and update required environment variables\n    ```sh\n     export ZOWE_CHAT_HOME=\u003cyour created folder\u003e/zoweChat\n     export ZOWE_CHAT_PLUGIN_HOME=\u003cyour created folder\u003e/plugins\n     export PATH=$PATH:$ZOWE_CHAT_HOME/bin\n    ```\n  - Update the plugin configuration file `$ZOWE_CHAT_PLUGIN_HOME/plugin.yaml` if necessary\n  - Execute the commands below to install local dependencies\n    ```sh\n    cd $ZOWE_CHAT_HOME/node_modules/i18next\n    npm link\n    cd  $ZOWE_CHAT_PLUGIN_HOME/@zowe/clicmd\n    npm link $ZOWE_CHAT_HOME\n    npm link i18next\n    cd  $ZOWE_CHAT_PLUGIN_HOME/@zowe/zos\n    npm link $ZOWE_CHAT_HOME\n    npm link i18next\n    ```\n  - Update Zowe Chat, chat tool and z/OSMF server configuration per your environment\n    ```sh\n    $ZOWE_CHAT_HOME/config/chatServer.yaml\n    $ZOWE_CHAT_HOME/config/zosmfServer.yaml\n    $ZOWE_CHAT_HOME/config/chatTools/\u003cmattermost | msteams | slack\u003e.yaml\n    ```\n  - Execute `chatsvr start` to start your Zowe Chat server\n    - `chatsvr status` - Check your Zowe Chat server status\n    - `chatsvr stop` - Stop your Zowe Chat server\n    - `chatsvr restart` - Restart your Zowe Chat server\n  - Launch your chat tool client and chat with your bot\n\n\u003cp\u003eHosting infrastructure for this project is supported by:\u003c/p\u003e\n\u003cp\u003e\n  \u003ca href=\"https://www.digitalocean.com/?refcode=77a4454d32a1\u0026utm_campaign=Referral_Invite\u0026utm_medium=Referral_Program\u0026utm_source=badge\"\u003e\n    \u003cimg src=\"https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg\" width=\"201px\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzowe%2Fzowe-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzowe%2Fzowe-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzowe%2Fzowe-chat/lists"}