prompt2db

AI-powered database X-ray. Analyze any PostgreSQL database and detect schema problems, scaling risks, and architecture issues in seconds.

Install

npx prompt2db xray          # run without installing
npm install -g prompt2db    # or install globally

Quick Start

# X-ray your database (works without an account)
prompt2db xray postgresql://user:pass@localhost:5432/mydb

# Or use DATABASE_URL from your environment
export DATABASE_URL=postgresql://user:pass@localhost:5432/mydb
prompt2db xray

Commands

prompt2db xray [connection-string]

Full database X-ray: schema visualization, health score, and architecture analysis.

prompt2db xray                           # uses DATABASE_URL env var
prompt2db xray postgresql://...          # explicit connection string
prompt2db xray --verbose                 # full schema tree (all tables)
prompt2db xray --json                    # JSON output for CI/CD pipelines

What it detects:

• Missing indexes on foreign key columns
• Unused/redundant indexes
• Unbounded growth tables (logs, events, sessions without TTL)
• Nullable column abuse (>60% nullable columns)
• Missing foreign key constraints
• Missing primary keys
• N+1 query risk patterns

prompt2db explain [connection-string]

AI-powered reverse engineering of your database architecture. Requires a Prompt2DB account.

prompt2db login
prompt2db explain                        # AI-powered analysis
prompt2db explain --local                # local heuristic fallback (no account needed)

prompt2db audit [connection-string]

Detailed schema audit report grouped by category.

prompt2db audit                          # AI-powered deep audit
prompt2db audit --local                  # local analysis (no account needed)
prompt2db audit --focus users,orders     # focus on specific tables

prompt2db login

Authenticate with the Prompt2DB platform to unlock AI-powered features.

prompt2db login
prompt2db login --email [email protected]

prompt2db costs

Show your current credit balance and action costs.

prompt2db costs

prompt2db logout

Clear stored authentication.

Credit Costs

| Action | Credits | |---------|---------| | X-ray | 2 | | Explain | 5 | | Audit | 8 |

Free features (no account needed): xray (local), explain --local, audit --local

Environment Variables

| Variable | Description | |----------|-------------| | DATABASE_URL | PostgreSQL connection string | | POSTGRES_URL | Alternative connection string |

Requirements

• Node.js >= 18
• PostgreSQL database (read-only access is sufficient)

License

MIT