Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 976 Bytes

installation.md

File metadata and controls

45 lines (30 loc) · 976 Bytes

QHub Installation

Pre-requisites

  • QHub is supported on the macOS and Linux operating systems.

    NOTE: Currently, QHub cannot be installed on Windows.

  • We recommend the adoption of virtual environments (conda, pipenv or venv) for successful usage.

Install QHub CLI

QHub's installation can be performed by using:

  • conda:
conda install -c conda-forge qhub
  • or pip (instead):
pip install qhub

Once finished, you can check QHub's version (and additional CLI args) by typing:

qhub --help

If successful, the CLI output will be similar to the following:

usage: qhub [-h] [-v] {deploy,render,init,validate,destroy,upgrade,keycloak} ...

QHub command line

positional arguments:
  {deploy,render,init,validate,destroy,upgrade,keycloak}
                        QHub - ||QHUB_VERSION||

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         QHub version