Skip to content
Interactive Terminal Interface

Everything happens inside the TUI. No complex scripts.

Forget about memorizing long CLI parameters. Just type `easysql` to launch a full visual terminal interface with tabs, keyboard navigation, instant history, and built-in slash commands.

Run instantly with npx or install globally with npm/bun

easysql — tui
v0.4.0
easysql │ conn: prod-pg PostgreSQL
Free ● online
Connections
History
▸ Question
Ask a question in plain English... Enter ↵
? Top 3 customers by revenue this month
SELECT-only (verified) 3 rows · 18ms execution · schema cached
Generated SQL
SELECT c.name AS customer_name,
       COUNT(o.id) AS orders,
       SUM(o.total_amount) AS revenue
  FROM customers c
  JOIN orders o ON o.customer_id = c.id
 WHERE o.created_at >= DATE_TRUNC('month', CURRENT_DATE)
 GROUP BY c.name
 ORDER BY revenue DESC
 LIMIT 3;
customer_nameordersrevenue
Acme Corp42$ 48,120.00
Globex Logistics28$ 31,480.50
Initech Solutions19$ 22,905.75
Tab / Shift-Tab: switch tabs · /help: commands · Ctrl-C: quit
/
Visual Flowchart

How EasySQL works inside the TUI

A smooth, interactive workflow right inside your terminal from start to finish.

Step 1 Terminal

Launch the TUI

Run `easysql` in your terminal. The interface loads your active connection, status, and navigation tabs.

easysql
Step 2 Inside TUI

Connect or test with /demo

Use the guided `/connect` command to add your database, or type `/demo` to test on a sample SQLite database in 2 seconds.

/connect or /demo
Step 3 You

Ask in plain language

In the Question tab, type what you need in plain English, Portuguese, or Spanish and press Enter.

"Top 5 customers by revenue this month"
Step 4 TUI Screen

Inspect SQL & see results

Inspect the verified SELECT SQL and view the formatted ASCII table on your screen. Your data never leaves your machine.

3 rows · 18ms execution
Inside the TUI

Commands & shortcuts inside the interface

Once the TUI is open, you control everything using simple slash commands and keyboard shortcuts.

Tab Navigation (Tab / Shift-Tab)

Connections
Tab 1

View registered databases (Postgres, MySQL, SQLite), verify online status, and inspect cached schemas.

History
Tab 2

Browse your previous questions, generated queries, and re-run past analyses with one keystroke.

Question
Tab 3 (Active)

Your primary prompt. Type your question in natural language, review the SQL, and explore tabular results.

Keybindings: Tab (next tab) · Shift-Tab (prev tab) · Enter (submit) · Ctrl-C (exit)

Interactive Slash Commands

Prefix: /
/login Authenticate your EasySQL account with your API key directly inside the TUI.
Auth
/connect Launch the interactive prompt to add a PostgreSQL, MySQL, MariaDB, or SQLite connection.
Database
/use <name> Switch the active connection instantly (e.g. `/use prod-db`).
Switch
/demo Generate a local SQLite database with sample customers and orders to test immediately.
Quick Test
/usage Check your plan usage: quota consumed in the rolling 5-hour window and weekly limit.
Quota
/history Open the read-only question and query execution log.
Logs
/help Display the complete list of available commands and keybindings in the terminal.
Help
Get Started in 3 Steps

How to start using the TUI

You only need one command to enter the interface. Everything else is done interactively.

01

Install or run with one command

Install globally via npm or bun, or launch directly without installing using npx.

# Run instantly without installing:
npx @easysql/cli

# Or install globally:
npm install -g @easysql/cli
# with Bun:
bun add -g @easysql/cli
02

Launch the TUI interface

Run `easysql` in your terminal to open the interactive shell.

# 1. Run easysql in your terminal
easysql

# 2. Inside the TUI, authenticate:
/login

# 3. Add your database via interactive wizard:
/connect

# Or test immediately on sample data with one command:
/demo

Security guarantee: Database credentials entered during `/connect` are encrypted locally in your operating system Keyring (AES-256). They never touch our servers.

03

Connect and ask inside the TUI

Type `/login` to sign in, `/connect` (or `/demo`) to setup your database, and ask your questions directly in the prompt.

# In the Question tab, just type your question and hit Enter:
? Top 3 customers by revenue this month

# Need to check your remaining query quota?
/usage

# Want to inspect previous queries?
/history
Security by Design

Built for peace of mind

Designed specifically for local and sensitive production databases.

Passwords never leave your machine

Database credentials stay in your local OS Keyring (AES-256). They are never sent to the cloud.

Encrypted locally

Zero table rows sent to cloud

Only schema structure (table names, columns, types) is analyzed to formulate queries. Row data stays local.

Encrypted locally

Strictly SELECT only

Destructive commands like INSERT, UPDATE, DELETE, or DROP are blocked before execution.

Encrypted locally

Ready to experience the interactive TUI?

Launch `npx @easysql/cli` right now and ask questions to your data in seconds.