Using the QCS CLI
Last updated
Was this helpful?
Last updated
Was this helpful?
The QCS CLI is a tool for interacting with QCS from the command line.
This guide refers to the new QCS CLI, made for working with pyQuil v3. If you're using pyQuil v2, refer to .
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:
Next, add the following to the for your shell environment ($HOME/.bashrc
or $HOME/.zshrc
, for instance), to ensure the qcs
command is available to every terminal session:
We don't currently have installation scripts for Windows. We recommend running the in the .
To run many commands, the CLI will need to know your QCS credentials. To add them to the CLI, run the following:
Once that completes, check that the following command executes successfully (requires a QCS account and access to a web browser):
You can check the latest available version with the latest
subcommand:
To update to the latest available version, use the update
subcommand:
The command displays the version of your current installation:
To make a reservation against a QPU, use the command, as described in our guide .
This guide touched on only the most commonly-used commands. For details on all available QCS CLI commands and configuration options, see the .