ContextQMD
Back to Yugabyte Db

Github

docs/content/stable/yugabyte-voyager/github.md

2026.1.0.0-b251.0 KB
Original Source
<!-- +++ private=true +++ -->

Perform the following steps to install yb-voyager using an installer script:

  1. Clone the yb-voyager repository.

    sh
    git clone https://github.com/yugabyte/yb-voyager.git

  2. Change the directory to yb-voyager/installer_scripts.

    sh
    cd yb-voyager/installer_scripts

  3. Install yb-voyager using the following script:

    sh
    ./install-yb-voyager

    To install a specific version of yb-voyager on your machine, use the following command:

    sh
    ./install-yb-voyager --version <VERSION>

    It is safe to execute the script multiple times. If the script fails, check the /tmp/install-yb-voyager.log file.

  4. The script generates a .yb-voyager.rc file in the home directory. Source the file to ensure that the environment variables are set using the following command:

    sh
    source ~/.yb-voyager.rc

  5. Check that yb-voyager is installed using the following command:

    sh
    yb-voyager version