Get Quantum CLI

New: quantum-cli v3, our PaaS: Runway 🚀

quantum-cli Basics #

Install #

Download the quantum-cli binary for your system, or use the Docker image at r.planetary-quantum.com/quantum-public/cli:3.

Configuration #

The api-key can be given on the command line:

$ quantum-cli --api-key yourkey endpoints ls

or you can

  • set the QUANTUM_API_KEY env variable
  • or create a ~/.config/quantum/env file:
QUANTUM_API_KEY=your-api-key

Basics #

$ quantum-cli help # (and -h after a subcommand) shows a short usage help
$ quantum-cli selfupdate # will update to the latest version

$ quantum-cli endpoints ls # the command to try first, should show all
$                          # the nodes you have access to

$ quantum-cli stack ls --endpoint foo # all stacks on that endpoint

Creating/Updating stacks #

This is described in detail on its own page.

A debug log is also available:

$ DEBUG=1 quantum-cli ...commands as usual...

Docker Image #

We make a docker image containing quantum-cli available at r.planetary-quantum.com/quantum-public/cli:3.

That image also contains some additional tools so you can use it directly even if you have build/publish steps:

  • docker (for docker build and docker login/docker push)
  • git
  • make, and jq

Example usage would be something like:

$ docker run -it --rm \
    -e QUANTUM_API_KEY=api-key \
    r.planetary-quantum.com/quantum-public/cli:3 \
    endpoints ls