summaryrefslogtreecommitdiffstats
path: root/debian/manpages/mycli.1
blob: fcf0bb59bc7cffd85656582a1b5b44de123196b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.TH "MYCLI" "1" "2.23.2" "mycli" "DBCLI"

.SH NAME
mycli \- CLI for MySQL/MariaDB with auto-completion and syntax highlighting

.SH SYNOPSIS
\fBmycli\fR [\fIOPTIONS\fR] [\fIDATABASE\fR]

.SH DESCRIPTION
mycli is a command line interface for MySQL/MariaDB with auto-completion and
syntax highlighting. It is also capable of pretty printing tabular data.

.SH OPTIONS
.IP "\-h|\-\-host \fITEXT\fR" 4
Host address of the database.

.IP "\-P|\-\-port \fIINTEGER\fR" 4
Port number to use for connection. Honors $MYSQL_TCP_PORT.

.IP "\-u|\-\-user \fITEXT\fR" 4
User name to connect to the database.

.IP "\-S|\-\-socket \fITEXT\fR" 4
The socket file to use for connection.

.IP "\-p|\-\-password|\-\-pass \fITEXT\fR" 4
Password to connect to the database.

.IP "\-v|\-\-version" 4
Version of mycli.

.IP "\-D|\-\-database \fITEXT\fR" 4
Database to use.

.IP "\-R|\-\-prompt \fITEXT\fR" 4
Prompt format (Default: "\\t \\u@\\h:\\d> ").

.IP "\-l|\-\-logfile \fIFILENAME\fR" 4
Log every query and its results to a file.

.IP "\-\-defaults\-group\-suffix \fITEXT\fR" 4
Read config group with the specified suffix.

.IP "\-\-defaults\-file \fIPATH\fR" 4
Only read default options from the given file.

.IP "\-\-login-path \fITEXT\fR" 4
Read this path from the login file.

.IP "\-\-help" 4
Shows the help message and exit.

.SH EXAMPLES
$ mycli my_database
.TP
$ mycli -u my_user -h my_host.com my_database
.TP
$ mycli mysql://my_user@my_host.com:3306/my_database

.SH SEE ALSO
litecli(1)
.TP
pgcli(1)
.TP
iredis(1)

.SH HOMEPAGE
More information about mycli and the DBCLI project can be found on the homepage at https://www.mycli.net and https://www.dbcli.com.

.SH AUTHORS
mycli was written by Amjith Ramanujam <amjith.r@gmail.com>.
.TP
This manual page was written by Lennart Weller <lhw@ring0.de>, for the Debian project (but may be used by others).