QCS CLI Reference
Last updated
Was this helpful?
Last updated
Was this helpful?
This document serves as a reference for QCS CLI commands and configuration.
For a guided tour of the QCS CLI, including how to install it and configure credentials, see .
help
Usage:
qcs help [<command>]
Display help for any specified command (or subcommand). If no command is given, this will display help for available top-level commands.
help-config
Usage:
qcs help-config
Display guidance.
help-input
Usage:
qcs help-input
Display guidance on formatting input to .
version
Usage:
qcs version [current|latest|update]
current
: Display version information for installed CLI (default).
latest
: Display version information for latest available CLI.
update
: Update installed CLI to latest available version.
Usage:
qcs api [<command>]
Usage:
qcs tools [<command>]
The tools
commands provide convenient helpers for common tasks.
See below (or use qcs help tools
) for details on available commands.
format-date
Usage:
qcs tools format-date <date-string>
Example:
will output:
reserve
Usage:
qcs tools reserve --quantum-processor-id <id> [<options>]
List available reservations for a QPU and interactively book.
Available Options:
--duration
, -d
string, default:
15m0s
Duration of reservation, specified as a sequence of positive or negative numbers, each with a time unit suffix.
Examples: 300ms
, -1.5h
or 2h45m
Valid time units are:
ns
: Nanoseconds
us
(or µs
): Microseconds
ms
: Milliseconds
s
: Seconds
m
: Minutes
h
: Hours
--next-available
boolean
Book the next available reservation.
Including this flag will immediately purchase the next available reservation, without additional confirmation.
--notes
string
Notes to add to reservation.
--quantum-processor-id
, -q
string, required
ID of quantum processor to reserve.
--start-time-from
, -s
string, default: current time
Time after which to search for available reservations.
QCS CLI commands derive configuration from the environment:
QCS_PROFILE_NAME
default
QCS_SETTINGS_FILE
~/.qcs/settings.toml
QCS_SECRETS_FILE
~/.qcs/secrets.toml
QCS_SETTINGS_FILE
(default
The api
commands provide a comprehensive set of ways to interact with the .
Use qcs help api
and for full details on using API commands.
All timestamps supplied to qcs api
subcommands must be in . Use to format a human-friendly date as an RFC3339 timestamp.
Format a human-friendly date string as an timestamp, for use with .
For details on allowed time formats, refer to .
The and secrets
commands provide functionality for reading and updating settings and credentials for the QCS CLI.
Use qcs help settings
, qcs help secrets
, and for full details on all available commands.