Doc

AutoCompletion

Auto-completion kicks in as soon as you start typing. The suggestions are context-sensitive so the REPL will only suggest relevant items.

Read More...

Config

The config file for mycli is located in the user's home folder (~/.myclirc).

Read More...

Environment Variables

In addition to the config file, mycli can also be governed by environment variables.

Read More...

Connect

How to connect to a MySQL compatible server using mycli.

Colors

Syntax highlighting has plenty of themes that can be changed via the config file.

Showcase of various color themes:

Gallery

Commands

Mycli has an assortment of commands to help you as you interact with a database.

Keybindings

There are two editing modes available: Emacs mode and Vi mode. The editing modes can be changed via the config file (~/.myclirc) or toggled via the F4 key.

Read more...

LLM Support

You can interact with an LLM directly at the mycli prompt.

Read more...

Dataframe Support

Mycli can transform query results using polars dataframes, and generate inline plots with Altair.

Read more...

Favorite Queries

Frequently used queries can be saved as named favorite queries.

Read More...

Logging

The default log file is located at ~/.mycli.log. There is additional user-friendly audit logging.

Read More..

Open Editor

Use the /edit command in the prompt to launch the default editor for a query.

Read More...

Multi-line mode

By default, mycli doesn't expect a semi-colon at the end of a line to execute the query, but this can be changed by setting the multi-line mode.

Read more...

History & Search

Mycli keeps track of the queries entered in the REPL. The Up/Down arrow key can be used to navigate the history.

Pressing <C-r> will enable incremental history search. Press <C-r> and then start typing your search term to see the queries narrowed down. If fzf is installed, history search can use powerful fuzzy matching.

Read more...

Working with multiple servers

When working with multiple servers, it is possible to store their connection parameters using DSN aliases, the system keyring, or mysql_config_editor.

Read more...

Pager Output

Mycli uses pager programs to make it easier to view large result sets. This can be configured or disabled.

Prompt

Mycli has a configurable prompt.