Area: Deployment
Sub-Area: CLI
Issue
Users are unable to install or use the latest version of the DataHub CLI, experiencing version compatibility issues between the CLI and the DataHub server, or encountering errors when running CLI commands.
Solution
Note: For DataHub Cloud customers, infrastructure-level changes are managed by DataHub Support.
- Install/upgrade CLI to match server version:
# Uninstall existing CLI
pip uninstall acryl-datahub
# Install specific version matching your DataHub server
pip install 'acryl-datahub[all]==X.Y.Z'
# Verify installation
datahub version
- Check Python version compatibility:
- DataHub CLI requires Python 3.8+
- Use a virtual environment to avoid conflicts:
python3 -m venv datahub-env
source datahub-env/bin/activate
pip install 'acryl-datahub[all]'
Troubleshoot installation errors:
- Clear pip cache:
pip cache purge - Upgrade pip:
pip install --upgrade pip - Install with verbose logging:
pip install -v 'acryl-datahub[all]' - Check for conflicting dependencies
- Clear pip cache:
Verify CLI-server compatibility:
- CLI version should match server major.minor version
- Example: CLI 0.13.x should work with DataHub 0.13.x server
- Check compatibility matrix in DataHub documentation
For cloud customers:
- Use CLI version recommended by DataHub Support for your instance
- Server version is displayed in DataHub UI footer or Settings page
Additional Notes
Test configurations in a development environment before applying to production. Always backup configurations before making changes.
Related Documentation
Related Tickets
- 5768, 5936, 5886, 5852, 5809, 5779, 5752, 5703, 5670, 5669, 5362, 5047, 4755, 4311, 5242
Tags:
cli, datahub-cli, installation, troubleshooting