https://github.com/hostwithquantum/setup-quantum-cli
A Github Action to deploy to Planetary Quantum's Docker platform.
https://github.com/hostwithquantum/setup-quantum-cli
deployment deployment-automation docker docker-swarm planetary-quantum
Last synced: 3 months ago
JSON representation
A Github Action to deploy to Planetary Quantum's Docker platform.
- Host: GitHub
- URL: https://github.com/hostwithquantum/setup-quantum-cli
- Owner: hostwithquantum
- License: mpl-2.0
- Created: 2024-04-09T08:53:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-28T21:58:41.000Z (3 months ago)
- Last Synced: 2026-03-28T22:27:35.867Z (3 months ago)
- Topics: deployment, deployment-automation, docker, docker-swarm, planetary-quantum
- Homepage: https://cli.planetary-quantum.com
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-quantum-cli
[](https://github.com/hostwithquantum/setup-quantum-cli/actions/workflows/ci.yml)
[](https://github.com/hostwithquantum/setup-quantum-cli)
[](https://opensource.org/licenses/MPL-2.0)
A GitHub Action to install and configure [`quantum-cli`](https://cli.planetary-quantum.com) 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](https://www.planetary-quantum.com/) 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](https://docs.planetary-quantum.com/).
### Quickstart
```yaml
steps:
- uses: hostwithquantum/setup-quantum-cli@v2
with:
api-key: ${{ secrets.QUANTUM_API_KEY }}
- run: quantum-cli auth status
```
### Full workflow example
```yaml
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
```yaml
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