setup-quantum-cli

A GitHub Action to install and configure quantum-cli for use in your CI/CD workflows. This action downloads the CLI, adds it to your PATH, and sets up authentication automatically.

Prerequisites

• A Planetary Quantum account with valid credentials

Supported platforms

OS	Architecture
Linux	amd64, arm64
macOS	amd64, arm64
Windows	amd64, arm64

Inputs

You should provide an api-key, but it's optional.

Input	Description
api-key	Your Quantum API key	optional, adds the key to the environment
version	The version	optional, defaults to latest
enable-cache	Cache quantum-cli endpoint data between runs	optional, defaults to true

Usage

For detailed documentation on the quantum-cli, please refer to our docs.

Quickstart

steps:
  - uses: hostwithquantum/setup-quantum-cli@v2
    with:
      api-key: ${{ secrets.QUANTUM_API_KEY }}
  - run: quantum-cli auth status

Full workflow example

name: Deploy

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: hostwithquantum/setup-quantum-cli@v2
        with:
          api-key: ${{ secrets.QUANTUM_API_KEY }}
      - run: quantum-cli auth status
      - run: quantum-cli stack deploy
        env:
          QUANTUM_ENDPOINT: my-cluster
          QUANTUM_STACK: my-app

Windows example

jobs:
  deploy:
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v6
      - uses: hostwithquantum/setup-quantum-cli@v2
        with:
          api-key: ${{ secrets.QUANTUM_API_KEY }}
      - run: quantum-cli.exe auth status

Environment variables

The action sets the following environment variables for subsequent steps:

When using API key:

• QUANTUM_API_KEY — your API key

Dependencies

• bash
• curl
• sha256sum
• actions/cache

License

MPL-2.0