Installation

Prerequisites

• Python 3.10 or higher
• pip for package installation

pip (Recommended)

Install db-sync-tool from PyPI:

pip install db-sync-tool-kmi

After installation, run:

db_sync_tool --help

Composer (PHP Projects)

For PHP framework projects, install via Packagist:

composer require kmi/db-sync-tool

Then install Python dependencies:

pip install -e vendor/kmi/db-sync-tool/

Run using:

python3 vendor/kmi/db-sync-tool/db_sync_tool

Shell Completion

db-sync-tool supports automatic shell completion for bash, zsh, fish, and PowerShell:

# Install completion for your shell
db_sync_tool --install-completion

# Restart your shell, then use tab completion
db_sync_tool --config<TAB>  # completes to --config-file

Verify Installation

# Check version
db_sync_tool --version

# View help
db_sync_tool --help

Next Steps

• Quick Start - Your first database sync
• Configuration - Learn about configuration options