Skip to main content

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

Project description

mycli

Build Status

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

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

Completion CompletionGif

Postgres Equivalent: http://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

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.
  • 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 whenever you need.
  • Timing of sql statements and table rendering.
  • Config file is automatically created at ~/.myclirc at first launch.
  • Log every query and its results to a file (disabled by default).
  • Pretty prints tabular data (with colors!)
  • Support for SSL connections
  • Shell-style trailing redirects with $>, $>> and $| operators.
  • 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

Follow the instructions on this blogpost: http://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-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.9 or better.

Mycli is not tested on Windows, but the libraries used in this app are Windows-compatible. This means it should work without any modifications. If you're unable to run it on Windows, please file a bug.

Configuration and Usage

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

Common topics include:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mycli-1.34.3.tar.gz (296.1 kB view details)

Uploaded Source

Built Distribution

mycli-1.34.3-py3-none-any.whl (75.0 kB view details)

Uploaded Python 3

File details

Details for the file mycli-1.34.3.tar.gz.

File metadata

  • Download URL: mycli-1.34.3.tar.gz
  • Upload date:
  • Size: 296.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mycli-1.34.3.tar.gz
Algorithm Hash digest
SHA256 cffb7c1eaddd6f11cad345e916cd66654a6a0a510da557e4a0292e536b2a441a
MD5 e9f2d9a9b3c630a28d31b82c450dc835
BLAKE2b-256 c243750c8711045236f7a3747b621425baaeb4e82031e28f4a1dcfd8566bd179

See more details on using hashes here.

Provenance

The following attestation bundles were made for mycli-1.34.3.tar.gz:

Publisher: publish.yml on dbcli/mycli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mycli-1.34.3-py3-none-any.whl.

File metadata

  • Download URL: mycli-1.34.3-py3-none-any.whl
  • Upload date:
  • Size: 75.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mycli-1.34.3-py3-none-any.whl
Algorithm Hash digest
SHA256 955b88a214f3eed51d033580b1fc33e7fc6b25843da442002fc3ed9b77193a28
MD5 0163733221401fba8b3e2247d3d57483
BLAKE2b-256 3f5d54b979a6578a556678523ae14f1a1faa4581959d0bf92a88a6ae31bd713d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mycli-1.34.3-py3-none-any.whl:

Publisher: publish.yml on dbcli/mycli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page