mycli

# mycli

[![Build Status](https://img.shields.io/github/actions/workflow/status/dbcli/mycli/ci.yml?style=for-the-badge&color=2E9356)](https://github.com/dbcli/mycli/actions/workflows/ci.yml)
[![PyPI - Version](https://img.shields.io/pypi/v/mycli?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/mycli/)
[![License](https://img.shields.io/github/license/dbcli/mycli.svg?style=for-the-badge&color=2E9356)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)

Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes.

Homepage: [https://mycli.net](https://mycli.net)

Documentation: [https://mycli.net/docs](https://mycli.net/docs)

<div align="center">
  <img alt="Completion" src="https://raw.githubusercontent.com/dbcli/mycli/main/doc/screenshots/tables.png">
</div>
</br>
<div align="center">
  <img alt="CompletionGif" src="https://raw.githubusercontent.com/dbcli/mycli/main/doc/screenshots/main.gif">
</div>

Mycli is known to be compatible with

 * [MySQL](https://www.mysql.com/)
 * [MariaDB](https://mariadb.org/)
 * [Percona](https://www.percona.com/)
 * [TiDB](https://www.pingcap.com/)
 * [Apache Doris](https://doris.apache.org/)

Postgres equivalent

 * [pgcli](https://pgcli.com)

# Release 2.x

Release 2.0.0 has [breaking changes](https://github.com/dbcli/mycli/blob/v2.0.0/changelog.md#breaking-changes)!


# Quick Start

If you already know how to install Python packages, then you can install mycli
via `pip`.  This package is always up to date.

```bash
pip install --upgrade 'mycli[all]'
```

or, on macOS (`pygments` is optional):

```bash
brew update && brew install mycli pygments
```

or, on Debian or Ubuntu (`fzf` and `pygments` are optional):

```bash
apt-get install mycli fzf python3-pygments
```

## Try Without Installing: uv

```bash
uv tool run 'mycli[all]' --help
```

## Try Without Installing: Docker

The images on Dockerhub are out of date!  [ghcr.io](https://github.com/dbcli/mycli/pkgs/container/mycli) images are preferred.  A sample database
is included:

```bash
docker run --pull=always -it ghcr.io/dbcli/mycli:latest
```

The same image works with macOS [container](https://github.com/apple/container):

```bash
container run -it ghcr.io/dbcli/mycli:latest
```

# Features

* Auto-completion as you type for SQL keywords as well as tables, views, columns, enums, and more!
* Smart-completion suggests context-sensitive completion:
    - `SELECT * FROM `<kbd>tab</kbd> will only show table names.
    - `SELECT * FROM users WHERE `<kbd>tab</kbd> will only show column names.
* Fuzzy history search using [fzf](https://github.com/junegunn/fzf).
* Output explorer using [fzf](https://github.com/junegunn/fzf) or other tools.
* Syntax highlighting using [Pygments](https://pygments.org/).
* Multiline queries.
* Favorite queries with positional or named parameters using [Jinja](https://jinja.palletsprojects.com/en/stable/). Save a query using
    ```
    /fs alias <query>
    ```
  and execute it with