The QCS CLI is a tool for interacting with QCS from the command line.
If you're using QCS via your provisioned JupyterLab IDE,
qcs is already installed for you. Otherwise, follow the steps below to install it locally.
Run the following in a terminal to download and install the CLI:
curl -s "https://qcs-cli.s3-us-west-2.amazonaws.com/latest/osx/install" | bash
curl -s "https://qcs-cli.s3-us-west-2.amazonaws.com/latest/linux/install" | bash
Next, add the following to the appropriate startup script for your shell environment (
$HOME/.zshrc, for instance), to ensure the
qcs command is available to every terminal session:
To run many commands, the CLI will need to know your QCS credentials. To add them to the CLI, run the following:
qcs secrets add-credentials default --auth-server-name default
Once that completes, check that the following command executes successfully (requires a QCS account and access to a web browser):
qcs api auth-get-user
qcs version command displays the version of your current installation:
You can check the latest available version with the
qcs version latest
To update to the latest available version, use the
qcs version update
This guide touched on only the most commonly-used commands. For details on all available QCS CLI commands and configuration options, see the QCS CLI Reference.