DocsUser GuideAdvanced Installation

Advanced Installation

We recommend the standard installation for most users. If you are a developer, or need more control over the installation, there are several alternative methods for installing the Crystal DBA CLI tool.

The instructions below are for the individual deployment model. If you are interested in the team deployment model, which enables monitoring, alerting, and historical analysis, please contact us.

Using pre-built binaries (Linux only)

If you do not have a Python environment, you can use the pre-built binaries, which come packaged with a Python interpreter.

  1. Visit the Crystal DBA releases page on GitHub to download the latest release of the Crystal DBA CLI tool for your operating system and architecture. It will be named following the pattern crystaldba-cli-<version>-<os>-<arch>.tar.gz.

  2. Extract the zip file:

tar -xf crystaldba-cli-<version>-<os>-<arch>.tar.gz
  1. Run the crystaldba command with your database connection string:
cd crystaldba-cli-<version>-<os>-<arch>
./crystaldba postgresql://<username>:<password>@<host>:<port>/<database>

Install the Python packages manually

  1. Visit the Crystal DBA releases page on GitHub and download the latest version of the .whl file, i.e., crystaldba-<version>-py3-none-any.whl.

  2. Install the whl file using pipx (or pip):

pipx install crystaldba-<version>-py3-none-any.whl
  1. Run the crystaldba command with your database connection string:
crystaldba postgresql://<username>:<password>@<host>:<port>/<database>

Using source (all platforms)

  1. Gather the pre-requisites:
  • You must have Python 3.10 or later installed.
  • You must have Poetry installed.

  1. Visit the Crystal DBA releases page on GitHub to download the source code bundle for the latest release. Extract the .zip or .tar.gz file. Alternatively, use git clone to clone the repository.

  2. Navigate to the directory where you extracted the source code bundle and into the agent directory.

  3. Run the Crystal DBA CLI and its dependencies:

poetry install
  1. Run the crystaldba command with your database connection string:
crystaldba postgresql://<username>:<password>@<host>:<port>/<database>