Install

Compatibility:

Mycli is tested on macOS and Linux. It runs on Python 3.10+.

Python Package:

The recommended way to install mycli is via the pip package manager (installation instructions for pip).

You might need sudo.

$ pip install mycli[all]

To install older versions, you may use e.g.

$ pip install mycli==1.20.0

macOS

The easiest way install mycli on a Mac is to use Homebrew.

$ brew update && brew install mycli

Linux

Mycli is provided by OS package maintainers in many distributions. These packages could be substantially out of date compared to pip/PyPi.

Arch, Manjaro

You can install the mycli package available in the AUR:

yay -S mycli

Debian, Ubuntu

On Debian and Ubuntu distributions, you can 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 running scoop install less.

Follow the instructions on this blogpost: http://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.