mysql-gui

library1.3.1jsnpmunverified

A web-based graphical user interface for MySQL database management. Version 1.3.1 requires Node.js >=16.0.0 and npm >=8.0.0. Supports local and remote database connections, CRUD operations, multi-tab interface, query editor with autocompletion, pagination, AI integration (OpenAI, Google Gemini) for SQL generation, and optional basic authentication. Available as an npm global package, from source, or via Docker. Designed for developers needing a quick, browser-based MySQL client with AI-assisted query writing.

database

npm install mysql-gui

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MYSQL-GUI

mysql-gui

databasejavascriptv1.3.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ npm install -g mysql-gui # then run: mysql-gui

✗ import mysqlGui from 'mysql-gui'

This package is a CLI tool, not a library. Do not import it in code.

Quick start with MySQL GUI via npm global install or Docker.

# Install globally npm install -g mysql-gui # Run the application mysql-gui # For Docker: docker run -d -p 5000:5000 --name mysql-gui -e "MYSQL_URL=mysql://root:root@host.docker.internal:3306" shashikumarkasturi/mysql-gui

Debug

Known issues

breakingRequires Node.js >=16.0.0 and npm >=8.0.0. Older versions will fail.

fix

Upgrade Node.js to version 16 or newer.

affects: <=1.3.1

gotchaThe package is a CLI tool. Do not import it as a module; it will not work.

fix

Use via command line or Docker.

affects: >=1.0.0

gotchaAI integration uses environment variables (AI_MODEL, AI_API_KEY). If these are not set, AI features will fail silently.

fix

Set AI_MODEL and AI_API_KEY in your environment or Docker compose file.

affects: >=1.3.0

gotchaDefault Docker image uses host.docker.internal for MySQL host. This only works on Docker for Windows/Mac, not Linux.

fix

Use the correct host (e.g., localhost or container network) for your OS.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'mysql-gui'

Trying to require/import the package in a Node.js script instead of using CLI.

fix

Use the CLI command `mysql-gui` or run via Docker.

Error: listen EADDRINUSE :::5000

Port 5000 already in use by another process.

fix

Kill the process using port 5000, or change the port with environment variable.

Upgrade

Version history

1.3.1latest on npm

Audit

Dependencies

mysqlrequiredMySQL driver for Node.js

expressrequiredWeb framework for serving the GUI

openaioptionalOptional: used for AI integration if enabled

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/kshashikumar/mysql-gui ↗

packagemysql-gui ↗

homepagehttps://github.com/kshashikumar/mysql-gui#readme ↗