@zowe/zowe-explorer-api

Visual Studio Code Plug-in for Zowe, which lets users interact with z/OS data sets on a remote mainframe instance. Powered by Zowe CLI.

Showing:

Popularity

Downloads/wk

70

GitHub Stars

127

Maintenance

Last Commit

3d ago

Contributors

68

Package

Dependencies

2

License

EPL-2.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Zowe Explorer

version downloads

Welcome to Zowe Explorer! Zowe Explorer brings mainframe capabilities to modern IDEs, such as VS Code. Zowe is a project hosted by the Open Mainframe Project, a Linux Foundation project.

Join our Slack channel to connect with the Zowe community.

Requirements

Client-side prerequisites:

Host-side prerequisites:

  • Configure TSO/E address space services, z/OS data set, file REST interface and z/OS jobs REST interface. For more information, see z/OS Requirements.

Directory Structure

Zowe Explorer repository includes several folders with files that let you build and configure various aspects of the extension. The bulk of the Zowe Explorer source code is in the packages directory. The packages folder has the following structure:

  • ├──packages — includes source code of Zowe Explorer, various Zowe Explorer-related extensions, and the extensibility API
    • ├──eslint-plugin-zowe-explorer — includes necessary files to configure ESLint plug-in for Zowe Explorer
    • ├──zowe-explorer-api — includes files to set up and use Extensibility API for Explorer. The API has two modules: Profiles API and Tree API.
    • ├──zowe-explorer-ftp-extension — includes files to set up and use the FTP extension for Zowe Explorer.
    • ├──zowe-explorer — core Zowe Explorer source files, ReadMe, Changelog, and more.

Build Locally

Ensure that you meet the software requirements before you build and test your Zowe Explorer.

Clone the repository, build a VSIX file, and start working with the extension.

  1. Clone the repository by issuing the following command in your local command-line interface:

    git clone --origin=upstream --branch=master --single-branch https://github.com/zowe/vscode-extension-for-zowe.git
    
  2. Change directories into the newly-cloned repository:

    cd vscode-extension-for-zowe
    
  3. From your local copy of the repository, issue the following commands:

    yarn install && yarn run package
    

You can find the VSIX file in the dist folder.

Now install the extension to VS Code.

  1. Navigate to the Extensions menu in VS Code and click the ... button in the top-left corner of the pane.
  2. Select Install from VSIX and select the .vsix file that was created by the commands you issued earlier.
  3. Restart Visual Studio Code.

You can now use the extension.

For more information on how to run tests for the extension, see Developer's ReadMe.

Available Documentation

The current repository of the VS Code extension Zowe Explorer includes several ReadMes that highlight different aspects of using the extension.

Use the following list with the description and links to find the topics of your interest:

Core Zowe Explorer ReadMe — contains information about how to install, configure, and use Zowe Explorer. This ReadMe helps you to familiarize yourself with the basic features of the extension.

Zowe Explorer ESlint Plug-in ReadMe — contains information about how to install ESLint and configure ESLint rules. ESLint helps you to find and fix problems in your JavaScript code.

Zowe Explorer Extensibility API ReadMe — contains information about how to extend the capabilities of Zowe Explorer, using the extensibility API.

Zowe Explorer FTP Extension ReadMe — contains information about how to install and use the Zowe Explorer extension for FTP. The extension adds the FTP protocol to Zowe Explorer, enabling you to use z/OS FTP Plug-in for Zowe CLI profiles to connect and interact with z/OS USS and MVS.

Note: Zowe Explorer FTP extension is an example that shows how the extensibility API is used to add new capabilities to Zowe Explorer.

Zowe Explorer Developer's ReadMe — contains information on how to install, build, and test Zowe Explorer.

Zowe Explorer in Theia ReadMe — contains information on how to develop for the Web-based IDE Eclipse Theia.

How to Contribute

We encourage you to contribute to Zowe Explorer!

Check the current open issues to choose where you can contribute. You can look for the help wanted-labeled issues to find issues that require additional input. If you are new to the project, you might want to check the issues with the good first issue label.

Also, you can check our Zenhub Communities boards for a more convenient view of issues and access to other boards of Zowe-related projects.

For more information on how to contribute, see Contributor Guidance.

Check out more about using Zowe Explorer and Zowe on Medium and Awesome Zowe.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100