query-cli

library1.0.8jsnpmunverified

A terminal-based database client with a keyboard-driven TUI, multi-connection support, and AI assistance. As of v1.0.8, it supports PostgreSQL, SQLite, and MySQL, with built-in query editing, schema exploration, and slash commands. It is distributed as a self-contained binary via npm/pnpm/yarn/bun (no Node or Bun runtime required on target). Key differentiators vs other CLI DB tools (like mycli, pgcli): modern TUI built with OpenTUI and React, native AI integration for SQL generation/explanation, and cross-platform releases via GitHub Actions.

database

npm install query-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · QUERY-CLI

query-cli

databasejavascriptv1.0.8

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import queryCli from 'query-cli'

✗ const queryCli = require('query-cli')

query-cli is a CLI tool not a library; importing is not standard usage. The package is meant to be run directly via npx or global install.

Run the query-cli terminal database client with one command using npx (no install required). On first launch, add a database connection (PostgreSQL, SQLite, or MySQL) and start querying.

npx query-cli

Debug

Known issues

gotchaCtrl+S may freeze terminals on Unix due to XOFF flow control.

fix

Press Ctrl+Q to resume or disable flow control with 'stty -ixon'.

affects: >=1.0.0

gotchaRunning via npx on first use may prompt for installation if not cached.

fix

Use 'npx query-cli' or install globally with 'npm i -g query-cli'.

affects: >=1.0.0

gotchaConfig is stored in ~/.config/query-cli/; deleting that directory resets all connections and queries.

fix

Backup config before uninstalling or clearing config.

affects: >=1.0.0

Errors

Common errors & fixes

ERROR: Missing required dependencies for MySQL driver

MySQL driver may require system libraries (libmysqlclient) not present.

fix

Install MySQL client libraries (e.g., 'apt-get install default-libmysqlclient-dev' on Debian/Ubuntu).

Error: Cannot find module 'query-cli'

Global install not in PATH or not installed correctly.

fix

Ensure node bin directory is in PATH, or reinstall globally with 'npm i -g query-cli'.

Upgrade

Version history

1.0.8latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

10 hits · last 30 days

node