The open-source CLI for PgStack. PgStack Access provides temporary, recorded access to PostgreSQL. Start a session from your terminal, then connect with psql or your favorite database client.
On macOS or Linux:
curl -fsSL https://pgstack.io/install.sh | bashThe installer downloads a standalone executable from this repository's GitHub Releases, verifies its SHA-256 checksum, and installs it to ~/.local/bin/pgstack. No Node.js or Bun installation is required. Add ~/.local/bin to your PATH if needed. Re-run the installer to upgrade.
Windows users can download pgstack-windows-x64.exe from the release assets. Linux releases include glibc and musl builds for x64 and arm64; macOS supports Intel and Apple Silicon.
To choose another installation directory:
curl -fsSL https://pgstack.io/install.sh | PGSTACK_INSTALL_DIR="$HOME/bin" bashSign in through your browser, confirm the code from your terminal, and connect the CLI:
pgstack auth login
pgstack access start --env production --reason "Investigate delayed orders"PgStack prints a temporary PostgreSQL connection URL. Use it with psql, a GUI, or another PostgreSQL client. You need a PgStack account and a project with Access configured; this CLI connects to the hosted PgStack API. Team admins and engineers can create, extend, and revoke their own sessions. Regular members can sign in and list their own active sessions.
Use a project slug directly, or select an environment. Replace angle-bracketed placeholders with your own slugs:
pgstack access start <project-slug> --duration 30m
pgstack access start --env stagingWhen several projects share an environment, the CLI shows slug - project name and asks which to use. Noninteractive commands require an unambiguous selection. Environment names are testing, development, staging, and production.
pgstack auth status
pgstack access list
pgstack access list <project-slug>
pgstack access extend <session-slug> --duration 15m
pgstack access revoke <session-slug> --reason "Investigation complete"
pgstack auth logoutSessions last up to one hour. Extensions add time but cannot leave more than one hour remaining. Expired or revoked sessions cannot be extended. Revocation ends access within one minute.
Use --organization <slug-or-id> when you belong to multiple organizations, --role <name> to select a configured database role, and --json for scripts. --reason is required when your project requires a reason. See pgstack --help and pgstack access --help for all commands.
Login opens your browser; pgstack auth login --no-browser prints the URL instead. Credentials are stored in ~/.config/pgstack/credentials.json. PGSTACK_CONFIG_DIR changes that location. Authentication renews during active CLI use and expires after 30 days of inactivity. Logout removes this computer's saved token; it does not invalidate copies or revoke Access sessions. Compiled releases always connect to https://api.pgstack.io.
The CLI is written in TypeScript and compiled with Bun. With Devbox installed:
make install
cp .env.example .env
make check
make test
make up auth
make build
./dist/pgstack --versionmake up loads .env, which defaults to https://api.pgstack.dev. Pass flags after Make's --, for example make up -- access start --env staging. You can also use make up ARGS="access start --env staging".
The public API contract is in src/api.ts. Match the backend's tRPC protocol version when updating dependencies. bun run build:releases creates platform binaries, SHA-256 files, and the version file in dist/releases/.
BemiDB history through v1.8.0 remains available in Git. Version 2.0.0 starts the CLI distribution; it does not replace the old runtime or provide a self-hosted PgStack backend. PgStack's hosted backend and infrastructure are maintained separately.
MIT. Previous versions retain their original licenses. See CONTRIBUTING.md and SECURITY.md.