Repository files navigation

The MySQL Shell Plugins Repository is a collection of plugins for the MySQL Shell (part of MySQL Server), written by the MySQL Client Tools team. It covers currently these plugins:

• GUI plugin: provides backend functionality for theMySQL Shell GUI application.
• MDS plugin: implementsMySQL Database Services and Oracle Cloud Infrastructure support
• MRS plugin: implementsMySQL REST Service support
• MSM plugin: implementsMySQL Schema Management operations

The GUI plugin backend and the other plugins can all be used on their own via MySQL Shell, but together they power theMySQL Shell GUI and theMySQL Shell for VS Code. Read the individual project readme files for more details, how to contribute and other information.

The following plugins are installed by copying the folders into the MySQL Shell Plugins directory:

• mds_plugin
• mrs_plugin
• msm_plugin

The plugins location for the MySQL Shell depends on the target platform:

• Windows: %appdata%\MySQL\mysqlsh\plugins
• Others: ~/.mysqlsh/plugins

For instructions about how to build and install the gui_plugin refer to the MySQL Shell GUIreadme.md.

For full documentation on MySQL Server, MySQL Shell and related topics, see:https://dev.mysql.com/doc/refman/en/

This project welcomes contributions from the community. Before submitting a pull request, pleasereview our contribution guide

Please consult thesecurity guide for our responsible security vulnerability disclosure process

License information can be found in the LICENSE.txt file.

This distribution may include materials developed by third parties. For license and attribution notices for these materials, please refer to the LICENSE file.

For additional downloads and the source of MySQL Shell (part of MySQL Server), visit:https://dev.mysql.com/downloads

Copyright © 2022, 2025, Oracle and/or its affiliates.