Documentation

Your friendly PostgreSQL companion for the terminal

Name: PgShell
Author: PgShell

Explore, modify, and monitor PostgreSQL with guided menus or one-line commands. No separate GUI—just Node.js, your shell, and clear, formatted output.

Get started in 30 seconds Commands & UI

Quick start

Install globally, add a .env (or use prompts), then run pgshell.

1
Install
```
npm install -g pgshell
```
2
Configure (optional)

Create a .env where you run the command, or paste a DATABASE_URL when prompted.
```
DB_HOST=localhost
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=your_password
DB_NAME=your_database
```
3
Run
```
pgshell
```
Opens the interactive menu. Without .env, you can store the password in your OS keychain.

Full installation and configuration →

Why PgShell

Interactive UI

Guided menus for databases, tables, inserts, structure, custom SQL, and live query monitoring.

CLI commands

One-liners like pgshell query "SELECT …" for scripts and quick checks.

Flexible auth

.env, URI, standard PG* vars, or prompts—with optional OS keychain storage.

Readable output

Tables and SQL highlighting designed for humans in a terminal—or read the same flows in this docs site.