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 must provide either api-key or both username and password. You cannot use both methods together.

Input	Description
api-key	Your Quantum API key (recommended)
username	Your Quantum username (deprecated, use api-key instead)
password	Your Quantum password (deprecated, use api-key instead)

Usage

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

Using API key (recommended)

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

Using username/password (deprecated)

Warning: username/password authentication is deprecated. Please migrate to api-key.

steps:
  - uses: hostwithquantum/setup-quantum-cli@v1
    with:
      username: ${{ secrets.QUANTUM_USERNAME }}
      password: ${{ secrets.QUANTUM_PASSWORD }}
  - 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@v1
        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@v1
        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

When using username/password (deprecated):

• QUANTUM_USER — your username
• QUANTUM_PASSWORD — your password

License

MPL-2.0