Skip to content

Commit 0f994b3

Browse files
committed
adding some todo's to readme
1 parent 036badb commit 0f994b3

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
# pgcli-docker
22
Dockerized version of the [pgcli](http://pgcli.com/) tool for postgres.
33

4-
## Why a docker version?
4+
### Why a docker version?
55

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.
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 easy to use on your own instances.
77

8-
## Installing
8+
### Installing
99

10-
Installing happings via a simple docker pull:
10+
Installing is a simple docker pull away:
1111

1212
`docker pull dencold/pgcli`
1313

14-
## Running
14+
### Running
1515

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:
16+
If you have a postgres container already running, all you need to do is link the postgres container to pgcli. For example, if your postgres container was named `my-postgres`, you can attach pgcli with this one-liner:
1717

1818
```docker run -it --link my-postgres:postgres --rm dencold/pgcli```
1919

2020
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.
2121

2222
## TODOs
23+
24+
* See if we can reference the `POSTGRES_ENV_POSTGRES_PASSWORD` variable in as an argument to pgcli, this would allow for automatic connection to the instance.
25+
* Update `run_pgcli.sh` to also run with raw arguments instead of just relying on docker link.

0 commit comments

Comments
 (0)