Using the Legacy QCS CLI

Search…
Your IDE comes pre-configured with the QCS Command-Line Interface (CLI). The CLI allows you to view a list of available QPU lattices, and easily book and manage reservations. The CLI is available directly after logging into your IDE, or from a terminal window of your JupyterLab notebook environment. 
Usage and Help
Once you've connected to your IDE, you can list all available CLI commands with the following command:
1
$ qcs help
2
​
3
The Rigetti QCS Command Line Interface (CLI)
4
​
5
VERSION
6
  qcs-cli/1.0.0 linux-x64 node-v8.16.1
7
​
8
USAGE
9
  $ qcs [COMMAND]
10
​
11
COMMANDS
12
  cancel        Cancel reservations in the compute schedule.
13
  devices       View available QPU devices.
14
  help          display help for qcs
15
  lattices      View available lattices.
16
  reservations  View the compute block schedule.
17
  reserve       Book reservations in the compute schedule.
18
  
Copied!
To use a command, simply type qcs followed by the command:
1
$ qcs devices
2
DEVICE
3
Name: Aspen-8
4
​
Copied!
To obtain more information about any command and possible flags type the command with --help flag
1
$ qcs devices --help
2
View available QPU devices.
3
​
4
USAGE
5
  $ qcs devices
6
​
7
OPTIONS
8
  -f, --format=json|json-pretty|tabular  [default: tabular] Data serialization format.
9
  -h, --help                             show CLI help
10
​
11
EXAMPLE
12
  $ qcs devices
Copied!
From the example above you can see that qcs will often display display its output in a variety of formats including JSON. The default tabular format is intended to be easy to read on a terminal. For certain commands, using one of the JSON formats will provide you with more detailed information than is available through the tabular format. JSON output is designed to support integrating CLI output into scripts or programs.
System Status Commands
devices - obtain a list of QPUs available for your account.
To obtain a list of available Rigetti QPUs use the devices command:
1
$ qcs devices
2
DEVICE
3
Name: Aspen-8
Copied!
If you use either --format=json or --format-json-pretty then you will see a JSON object containing additional information about each QPU that is available. It is beyond the scope of this document to describe the JSON format and that format is subject to change without notice.
QPU Reservation Commands
reserve - make a reservation for QPU time
To create a new reservation for QPU time, use the reserve command and follow the prompts. The following describes 
1
$ qcs reserve
2
Available credits: $5,000.00
3
​
4
The next available compute block is:
5
​
6
START                    END                      DURATION  LATTICE            PRICE
7
2020-07-19 17:00 PDT     2020-07-19 17:15 PDT     15.00m    Aspen-8            $0.00
8
​
9
Accept? Type (y)es, (n)o to continue looking, or (q)uit: y
10
Booking reservation(s)...
11
Reservation(s) confirmed, run 'qcs reservations' to see the latest schedule.
12
​
Copied!
If you type n at the prompt asking to accept the next available block, you will be presented with a list of alternative reservations to choose from.
Flag
Action
start
Specify a start time for the reservation (defalut is now). You can be fairly free form, but if you have spaces use quotes. e.g. "Friday at 5pm".
duration
Duration of requested reservation.
reservations - list QPU reservations for your account.
To obtain a list of pending reservations for your account, use the reservations command.
1
$ qcs reservations
2
UPCOMING COMPUTE BLOCKS
3
ID    START                    END                      DURATION  LATTICE            PRICE
4
34857 2020-07-19 17:00 PDT     2020-07-19 17:15 PDT     15.00m    Aspen-8            $0.00
5
​
Copied!
cancel - cancel a reservation
To delete a pending reservation use the cancel command.  This is the same as deleting a reservation with the reserve --delete command.
1
$ qcs cancel --id=34857
2
UPCOMING COMPUTE BLOCKS
3
ID    START                    END                      DURATION  LATTICE            PRICE
4
34857 2020-07-19 17:00 PDT     2020-07-19 17:15 PDT     15.00m    Aspen-8            $0.00
5
​
6
​
7
Cancel reservation(s)? (y)es, (N)o: y
8
Reservation(s) cancelled. Type 'qcs reservations' to see the latest schedule.
9
​
Copied!
Using the QCS CLI
QPUs vs. QVMs
Last modified 3mo ago
Copy link
Contents
Usage and Help
System Status Commands
QPU Reservation Commands