Skip to content

ilhanaydinli/dbcli

Repository files navigation

🗄️ dbcli

A powerful, interactive CLI tool for managing database connections, imports, exports, and operations.

License: MIT npm version


✨ Features

Feature Description
🔌 Connection Management Save, edit, and manage multiple database configurations
📥 Import Import dump files with optional DB reset before import
📤 Export Backup databases to custom-named dump files
🗃️ Database Operations Create, clone, rename, and drop databases
⚙️ Config Import/Export Backup and restore your connection settings

📦 Installation

Prerequisites

  • Database client tools for your target database:
    • PostgreSQL: psql, pg_dump
    • MySQL/MariaDB: mysql, mysqldump (coming soon)
    • MongoDB: mongosh, mongodump (coming soon)

Install globally

bun install -g @ilhanaydinli/dbcli

🚀 Usage

# Start the interactive CLI
dbcli

Main Menu

┌  dbcli v1.0.0
│
◆  What would you like to do?
│  ● Import Database
│  ○ Export Database
│  ○ Manage Connections
│  ○ Settings
│  ○ Exit
└

📖 Commands

🔌 Manage Connections

Add, edit, list, or remove database connection configurations.

📥 Import Database

  1. Select a saved connection
  2. Select target database (or create a new one)
  3. Select a dump file from the current directory
  4. Optionally reset the database before import
  5. Import executes using native database tools

📤 Export Database

  1. Select a saved connection
  2. Enter the output filename
  3. Export creates a dump file using native tools

🗃️ Database Operations

Manage databases on a selected connection:

  • Create — Create a new database
  • Clone — Duplicate an existing database
  • Rename — Rename a database
  • Drop — Delete a database (with confirmation)

⚙️ Settings

  • Toggle Verbose Mode — Show/hide detailed output
  • Export Config — Save connections to a JSON file
  • Import Config — Load connections from a JSON file

🗃️ Supported Databases

Database Status Import Export Manage
PostgreSQL ✅ Supported
MySQL ⬜ Planned
MariaDB ⬜ Planned
MongoDB ⬜ Planned
MS SQL Server ⬜ Planned

📜 License

This project is licensed under the MIT License — see the LICENSE file for details.

About

A powerful, interactive CLI tool for managing database connections, imports, exports, and operations.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors