Skip to content

Commit 036badb

Browse files
committed
adding a proper README
1 parent c510400 commit 036badb

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
# pgcli-docker
2-
Docker-ized version of the cli tool for postgres
2+
Dockerized version of the [pgcli](http://pgcli.com/) tool for postgres.
3+
4+
## Why a docker version?
5+
6+
I generally run my development apps with a separate container for the postgres database. Hooking up the database to the application is achieved via docker [links](https://docs.docker.com/userguide/dockerlinks/). In order to make it easy to use `pgcli` on any postgres container, I've made a simple docker wrapper for the command. It is smart about pulling in the linked postgres environment variables and makes it dead-easy to use on your own instances.
7+
8+
## Installing
9+
10+
Installing happings via a simple docker pull:
11+
12+
`docker pull dencold/pgcli`
13+
14+
## Running
15+
16+
If you have a postgres container already running, all you need to do is run pgcli with a link setup. For example, if your postgres container was named `my-postgres`, you can attach pgcli with this one-liner:
17+
18+
```docker run -it --link my-postgres:postgres --rm dencold/pgcli```
19+
20+
You'll get a prompt for password, once authenticated you'll be in a pgcli session. When you exit, the container will automatically be cleaned up.
21+
22+
## TODOs

0 commit comments

Comments
 (0)