pgweb/README.md

42 lines
851 B
Markdown
Raw Normal View History

2014-10-08 21:29:43 -05:00
# pgweb
2014-10-10 21:06:08 -05:00
Web-based PostgreSQL database browser written in Go.
2014-10-08 21:29:43 -05:00
## Usage
CLI options:
```
-h, --host= Server hostname or IP (localhost)
-p, --port= Server port (5432)
-u, --user= Database user (postgres)
-d, --db= Database name (postgres)
2014-10-10 21:06:08 -05:00
--url= Database connection string (postgresql://...)
--ssl= SSL option (disable)
2014-10-08 21:29:43 -05:00
```
2014-10-10 21:06:08 -05:00
## Compile from source
2014-10-08 21:54:49 -05:00
2014-10-10 21:06:08 -05:00
Go 1.3+ is required. You can install Go with `homebrew`:
2014-10-08 21:54:49 -05:00
```
2014-10-10 21:06:08 -05:00
brew install go
2014-10-09 19:23:19 -05:00
```
2014-10-10 21:06:08 -05:00
To compile source code run the following command:
2014-10-08 21:29:43 -05:00
```
2014-10-10 21:06:08 -05:00
go get
go build
2014-10-09 19:23:19 -05:00
```
2014-10-13 15:19:11 -05:00
This will produce `pgweb` binary in the current directory.
## TODO
- [ ] Change server port to something better
- [ ] Add ability to switch between databases
- [ ] More detailed usage / help section
- [ ] Build for linux and windows
- [ ] Add view to see table details (not only structure)
- [ ] Make results table rows sortable