What is MyCli?
A MyCli is command line client for MySQL that can do auto-completion and syntax highlighting.
HomePage: http://mycli.net Documentation: http://mycli.net/docs
Installing MyCli on Linux, Mac & Windows
If you already know how to install python packages, then you can install it via pip:
Note: If python is not installed follow these instructions (For Windows).
You might need sudo on linux.
$ pip install -U myclior
$ brew update && brew install mycli # Only on macOSor
$ sudo apt-get install mycli # Only on debian or ubuntuAfter installing MyCli on Windows you need to install less pager. You can install it from here.
Usage
$ mycli --help
Usage: mycli [OPTIONS] [DATABASE]
A MySQL terminal client with auto-completion and syntax highlighting.
Examples:
- mycli my_database
- mycli -u my_user -h my_host.com my_database
- mycli mysql://my_user@my_host.com:3306/my_database
Options:
-h, --host TEXT Host address of the database.
-P, --port INTEGER Port number to use for connection. Honors
$MYSQL_TCP_PORT.
-u, --user TEXT User name to connect to the database.
-S, --socket TEXT The socket file to use for connection.
-p, --password TEXT Password to connect to the database.
--pass TEXT Password to connect to the database.
--ssh-user TEXT User name to connect to ssh server.
--ssh-host TEXT Host name to connect to ssh server.
--ssh-port INTEGER Port to connect to ssh server.
--ssh-password TEXT Password to connect to ssh server.
--ssh-key-filename TEXT Private key filename (identify file) for the
ssh connection.
--ssh-config-path TEXT Path to ssh configuration.
--ssh-config-host TEXT Host to connect to ssh server reading from ssh
configuration.
--ssl Enable SSL for connection (automatically
enabled with other flags).
--ssl-ca PATH CA file in PEM format.
--ssl-capath TEXT CA directory.
--ssl-cert PATH X509 cert in PEM format.
--ssl-key PATH X509 key in PEM format.
--ssl-cipher TEXT SSL cipher to use.
--ssl-verify-server-cert Verify server's "Common Name" in its cert
against hostname used when connecting. This
option is disabled by default.
-V, --version Output mycli's version.
-v, --verbose Verbose output.
-D, --database TEXT Database to use.
-d, --dsn TEXT Use DSN configured into the [alias_dsn]
section of myclirc file.
--list-dsn list of DSN configured into the [alias_dsn]
section of myclirc file.
--list-ssh-config list ssh configurations in the ssh config
(requires paramiko).
-R, --prompt TEXT Prompt format (Default: "\t \u@\h:\d> ").
-l, --logfile FILENAME Log every query and its results to a file.
--defaults-group-suffix TEXT Read MySQL config groups with the specified
suffix.
--defaults-file PATH Only read MySQL options from the given file.
--myclirc PATH Location of myclirc file.
--auto-vertical-output Automatically switch to vertical output mode
if the result is wider than the terminal
width.
-t, --table Display batch output in table format.
--csv Display batch output in CSV format.
--warn / --no-warn Warn before running a destructive query.
--local-infile BOOLEAN Enable/disable LOAD DATA LOCAL INFILE.
-g, --login-path TEXT Read this path from the login file.
-e, --execute TEXT Execute command and quit.
--init-command TEXT SQL statement to execute after connecting.
--charset TEXT Character set for MySQL session.
--password-file PATH File or FIFO path containing the password
to connect to the db if not specified otherwise
--help Show this message and exit.Features
- 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 queryand execute it with\f aliaswhenever you need. - Timing of sql statements and table rendering.
- Config file is automatically created at
~/.myclircat first launch. - Log every query and its results to a file (disabled by default).
- Pretty prints tabular data (with colors!)
- Support for SSL connections
Some features are only exposed as Key Bindings:
The following key bindings are special to mycli:
F2
Enable/Disable SmartCompletion Mode.
F3
Enable/Disable Multiline Mode.
F4
Toggle between Vi and Emacs mode.
Tab
Force autocompletion at cursor.
C-space
Initialize autocompletion at cursor.
If the autocompletion menu is not showing, display it with the appropriate completions for the context.
If the menu is showing, select the next completion.
ESC Enter
Introduce a line break in multi-line mode, or dispatch the command in single-line mode.
The sequence ESC-Enter is often sent by Alt-Enter.
C-x p (Emacs-mode) or > (Vi-mode)
Prettify and indent current statement, usually into multiple lines.
Only accepts buffers containing single SQL statements.
C-x u (Emacs-mode) or < (Vi-mode)
Unprettify and dedent current statement, usually into one line.
Only accepts buffers containing single SQL statements.
Contributions:
If you’re interested in contributing to this project, you can find source code here.
