mycli 1.74.0

CLI for MySQL Database. With auto-completion and syntax highlighting.

mycli

A command line client for MySQL that can do auto-completion and syntax highlighting.

Homepage: https://mycli.net Documentation: https://mycli.net/docs

Mycli is compatible with MySQL, MariaDB, Percona, TiDB, and Doris.

Postgres Equivalent: https://pgcli.com

Quick Start

If you already know how to install Python packages, then you can install it via pip:

You might need sudo on Linux.

pip install -U 'mycli[all]'

or

brew update && brew install mycli  # Only on macOS

or

sudo apt-get install mycli  # Only on Debian or Ubuntu

Usage

See

mycli --help

Features

mycli is written using prompt_toolkit.

• Auto-completion as you type for SQL keywords as well as tables, views and columns in the database.
• Fuzzy history search using fzf.
• Syntax highlighting using Pygments.
• Smart-completion (enabled by default) will suggest context-sensitive completion.
  • SELECT * FROM <tab> will only show table names.
  • SELECT * FROM users WHERE <tab> will only show column names.
• Support for multiline queries.
• Favorite queries with optional positional parameters. Save a query using \fs <alias> <query> and execute it with \f <alias>.
• Timing of sql statements and table rendering.
• Log every query and its results to a file (disabled by default).
• Pretty print tabular data (with colors!).
• Support for SSL connections
• Shell-style trailing redirects with $>, $>> and $| operators.
• Support for querying LLMs with context derived from your schema.
• Support for storing passwords in the system keyring.

Mycli creates a config file ~/.myclirc on first run; you can use the options in that file to configure the above features, and more.

Some features are only exposed as key bindings.

Contributions:

If you're interested in contributing to this project, first of all I would like to extend my heartfelt gratitude. I've written a small doc to describe how to get this running in a development setup.

https://github.com/dbcli/mycli/blob/main/CONTRIBUTING.md

Additional Install Instructions:

These are some alternative ways to install mycli that are not managed by our team but provided by OS package maintainers. These packages could be slightly out of date and take time to release the latest version.

Arch, Manjaro

You can install the mycli package available in the AUR:

yay -S mycli

Debian, Ubuntu

On Debian, Ubuntu distributions, you can easily install the mycli package using apt:

sudo apt-get install mycli

Fedora

Fedora has a package available for mycli, install it using dnf:

sudo dnf install mycli

Windows

Option 1: Native Windows

Install the less pager, for example by scoop install less.

Follow the instructions on this blogpost: https://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/

Mycli is not tested on Windows, but the libraries used in the app are Windows-compatible. This means it should work without any modifications, but isn't supported.

PRs to add native Windows testing to Mycli CI would be welcome!

Option 2: WSL

Everything should work as expected in WSL. This is a good option for using Mycli on Windows.

Thanks:

This project was funded through kickstarter. My thanks to the backers who supported the project.

A special thanks to Jonathan Slenders for creating Python Prompt Toolkit, which is quite literally the backbone library, that made this app possible. Jonathan has also provided valuable feedback and support during the development of this app.

Click is used for command line option parsing and printing error messages.

Thanks to PyMysql for a pure python adapter to MySQL database.

Compatibility

Mycli is tested on macOS and Linux, and requires Python 3.10 or better.

To connect to MySQL versions earlier than 5.5, you may need to set the following in ~/.myclirc:

# character set for connections without --charset being set at the CLI
default_character_set = utf8

or set --charset=utf8 when invoking MyCLI.

Configuration and Usage

For more information on using and configuring mycli, check out our documentation.

Common topics include:

• Configuring mycli
• Using/Disabling the pager
• Syntax colors