Skip to main content

A CLI tool for managing databases on VPS systems

Project description

CLIDB - Simple Database Management CLI

A command-line tool for managing databases on VPS systems using Docker containers. Supports multiple database types and provides ready-to-use connection strings.

Supported Databases

  • PostgreSQL (versions 11-16)
  • MySQL (8.0, 5.7)
  • MariaDB (11.0, 10.11, 10.10)
  • Redis (7.2, 7.0, 6.2)
  • MongoDB (7.0, 6.0, 5.0)
  • Neo4j (5, 4.4)

Prerequisites

  • Python 3.8 or higher
  • Docker installed and running
  • pip (Python package installer)

Installation

pip install clidbs

Usage

Create a Database

# Create a PostgreSQL database (latest version)
clidb create mydb

# Create a specific version
clidb create mydb --type postgres --version 16

# Create other database types
clidb create myredis --type redis --version 7.2
clidb create mymongo --type mongo
clidb create mysql1 --type mysql --version 8.0

The tool will output connection details including:

  • Connection string (ready to copy/paste)
  • CLI command with credentials
  • Host/IP address (automatically detected)
  • Port, user, and password

Manage Databases

# List all databases
clidb list

# Stop a database
clidb stop mydb

# Start a database
clidb start mydb

# Remove a database
clidb remove mydb

# See supported databases and versions
clidb supported

Public vs Private Access

# Create with public access (default)
clidb create mydb --access public

# Create with private access (localhost only)
clidb create mydb --access private

Discord Notifications

Enable notifications by:

  1. Setting the webhook URL in command:
clidb create mydb --discord-webhook "YOUR_WEBHOOK_URL"
  1. Or using environment variable:
export CLIDB_DISCORD_WEBHOOK="YOUR_WEBHOOK_URL"

Configuration

Environment variables:

  • CLIDB_DISCORD_WEBHOOK: Discord webhook URL
  • CLIDB_HOST_IP: Override auto-detected IP address
  • CLIDB_DEFAULT_DB: Default database type (defaults to "postgres")
  • CLIDB_DEFAULT_PORT: Default port for the database

Security

  • Secure random passwords generated for each database
  • Private mode uses host networking for better security
  • Public mode exposes ports for remote access
  • Connection strings provided with proper credentials
  • Discord notifications exclude sensitive information

License

MIT License

Create different types of databases

clidb create mypostgres --type postgres --version 16 clidb create mymongo --type mongo --version 7.0 clidb create myredis --type redis clidb create mysql1 --type mysql --version 8.0

List all databases

clidb list

See supported databases and versions

clidb supported

Start/stop any database

clidb stop mypostgres clidb start mymongo

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clidbs-0.5.1.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clidbs-0.5.1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file clidbs-0.5.1.tar.gz.

File metadata

  • Download URL: clidbs-0.5.1.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for clidbs-0.5.1.tar.gz
Algorithm Hash digest
SHA256 2ce86c2f468be04e4404e8a03d9b9eca64bac2eb7be59003c04673a60145cd25
MD5 282954cee8fbeba3614fb25acc87cf34
BLAKE2b-256 ee74f9b10a03c080d8382982d5fd68ae58b3c78147f8ab61052435c495e844b7

See more details on using hashes here.

File details

Details for the file clidbs-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: clidbs-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for clidbs-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 61161988171dbd5edd006b4253fcea90f2e3222ed8dc80fa2a26b8ee62a34bca
MD5 d50aa25b6c536d6f4c88e3ee0f510ef4
BLAKE2b-256 3d76ee52a9eeed47b7947c0a9f42c60ecb121b70bcd2763b4c2f341d6b63201f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page