summaryrefslogtreecommitdiffstats
path: root/debian/manpages/pgcli.1
blob: 0628377cb61e6e1a5b232dbe48b210396359e79d (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
.TH "PGCLI" "1" "3.1.0" "pgcli" "DBCLI"

.SH NAME
pgcli \- CLI for PostgreSQL with auto-completion and syntax highlighting

.SH SYNOPSIS
\fBpgcli\fR [\fIOPTIONS\fR] [\fIDATABASE\fR] [\fIUSERNAME\fR]

.SH DESCRIPTION
pgcli is a command line interface for PostgreSQL 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 postgres database.

.IP "\-p|\-\-port \fIINTEGER\fR" 4
Port number at which the postgres instance is listening.

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

.IP "\-W|\-\-password" 4
Force password prompt.

.IP "\-w|\-\-no-password" 4
Never prompt for password.

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

.IP "\-d|\-\-dbname \fITEXT\fR" 4
Database name to connect to.

.IP "\-\-pgclirc \fITEXT\fR" 4
Location of pgclirc file.

.IP "\-\-help" 4
Show this message and exit.

.SH EXAMPLES
$ pgcli local_database
.TP
$ pgcli postgres://amjith:passw0rd@example.com:5432/app_db
.TP
$ pgcli -h localhost -p 5432 -U amjith app_db

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

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

.SH AUTHORS
pgcli 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).