Skip to content
rexadbappPublic

About

nvim-style Database client

Resources

Stars

6 stars

Watchers

0 watching

Forks

Repository files navigation

surp

License: MIT Open Source

Open source nvim-style terminal client for Supabase — manage projects, tables, SQL, edge functions, storage, auth users, and more from your terminal. Free, no account required. Source on GitHub under the MIT license — contributions welcome.

Install

npm install -g @rexadbapp/surp

Or run without installing:

npx @rexadbapp/surp

The npm package downloads the correct precompiled binary for your platform from GitHub Releases at install time — no source code is shipped.

Supported platforms: macOS (arm64 / x64), Linux (x64), Windows (x64).

Getting started

  1. Launch surp.

  2. Authenticate with your Supabase account:

    :login
    

    This opens a browser-based Supabase login flow and stores a personal access token. surp talks directly to the Supabase Management API — no RexaDB account, subscription, or license is required.

Connecting to any Postgres database

surp isn't limited to Supabase — you can point it at any PostgreSQL database and get the tables browser, SQL editor, row editing, schema ERD, linter, and storage/auth browsing over a direct connection.

:connect postgres://user:password@host:5432/mydb?sslmode=disable

Or save named profiles for quick reuse:

:connections     " manage saved connections + create new ones
:connect prod    " connect to the profile named "prod"
:disconnect      " drop the active connection

In the :connections buffer, press u (or pick "paste connection string") to connect from just a DSN — no form fields needed. enter connects, n opens the field-by-field form instead, d deletes a profile, x disconnects. Profiles are stored in ~/.config/surp/connections.json with 0600 permissions.

Supabase projects remain first-class — pick one from :projects and everything works as before.

Command Description
:connect <dsn|profile> Connect to any Postgres DB or a saved profile
:connections Manage saved connections
:disconnect Disconnect from the active database

Architecture note

All data sources plug into a common driver layer (src/connections/). A driver advertises its capabilities (SQL, schema browsing, logs, …) and every feature gates on those, so adding another backend (MySQL, SQLite, …) means dropping a single new driver file into src/connections/drivers/.

Commands

Command Description
:login Sign in to Supabase
:logout Sign out of Supabase
:account Show version and update status
:update Check for and apply updates from GitHub
:check-update Show whether a newer version is available
:projects Browse your Supabase projects

Building from source

Requires Bun v1.2+.

git clone https://github.com/rexadbapp/surp.git
cd surp
bun install
bun run dev        # run from source
bun run build      # build a binary for your platform (dist/)

Releasing

Maintainers: bun run scripts/release.mjs builds all platforms, uploads to GitHub Releases via gh, and offers to publish the npm package. The script prompts for the version and will offer to bump package.json + cli/package.json if you forgot.

Open Source

surp is fully open source under the MIT license. Source, issues and pull requests live on GitHub — contributions welcome.

License

MIT — see LICENSE for details.

About

nvim-style Database client

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages