Skip to content

Latest commit

 

History

History
63 lines (31 loc) · 1.87 KB

README.md

File metadata and controls

63 lines (31 loc) · 1.87 KB

db-cli

GitHub tag (latest by date)   GitHub

Database CLI tool for Creating, Copying, and Syncing databases quickly. It can create local databases, copy local or remote database or copy remote to local databases. It will not write to remote databases (for peace of mind). It uses Project Config Files to store the settings for each project. Prject Config files and Backups will be stored in ~/.dbcli

* Currently only supports mysql and mariadb
* Requires mysql-client to be installed on your system
* All Databases are collated as utf8mb4_unicode_ci

db-cli gif

Installation

npm i --global @ggedde/db-cli

Test that the CLI is working and see what Version it is

db -v

See Help

db -h

* If it does not work then you might need to add the global path to your $PATH

db add [project_config_file]

    Adds a new project_config_file, but does not create a local database

db copy [-o] [project_config_file]

    Copies Remote Database to Local Database using the project_config_file.
    Local Database will be backup before getting overwritten

    -o   Omits the backup files. Use only if you are sure you will not need to revert back.

db create [-a] [project_config_file]

    Creates a new database on your localhost

    -a   Also add a new project_config_file

db backup [-l | -r] [project_config_file]

    Backsup databases from both local and remote

    -l   Backup local database Only
    -r   Backup remote database Only

db backups

    List all Backup Files in the Backups Folder

db list

    List all Project Config Files in the Databases Folder