Quickstart
Five minutes from download to the first row on screen. This walkthrough assumes you have a PostgreSQL database you can reach from your laptop and the connection details to hand.
1. Install SeeKi
Grab the binary for your platform. Full options live on the Install page; the one-liner below covers macOS and Linux.
curl -L -o seeki https://github.com/kiriketsuki/seeKi/releases/latest/download/seeki-$(uname -s)-$(uname -m)
chmod +x seeki
2. Write a seeki.toml
Create a file called seeki.toml next to the binary. The minimum SeeKi needs is a server address and a database connection string.
[server]
host = "127.0.0.1"
port = 3141
[database]
kind = "postgres"
url = "postgres://user:password@localhost:5432/mydb"
max_connections = 5
3. Run it
./seeki
# SeeKi listening on http://127.0.0.1:3141
SeeKi stays in the foreground and prints a log line for each request. Leave the terminal open while you use it; press Ctrl+C to stop.
4. Open the browser
Visit http://127.0.0.1:3141. The sidebar lists every table you allowed, with row counts. Click one to see its rows in the grid.
5. Browse, sort, filter, export
- Sort — click any column header. Click again to reverse; a third click clears the sort.
- Search — the toolbar search box looks across every text column in the current table.
- Filter one column — open the column menu from the header and type a value.
- Hide columns — use the column menu to hide anything you don’t need. Your choices are remembered on the next visit.
- Export — the Export button saves the current view as a CSV with friendly column names.
You’re done
That’s the whole loop: point SeeKi at a database, open the browser, read the data. No query editor to learn, nothing to install alongside it.
Next steps
- Connections — all the ways to describe your database.
- Config reference — every option in
seeki.toml. - SSH tunneling — reach a database that only a bastion host can see.
- Branding — replace the SeeKi title with your team’s name.