Skip to main content

QCOS CLI Reference

Command-line interface for the QCOS platform.

Package: pip install softqcos · Binary: softqcos · Commands: 162 · Python: 3.10+


Installation

pip install softqcos

Authentication

# Set API key
export QCOS_API_KEY="qcos_..."

# Or configure once
softqcos config set api_key "qcos_..."

# Verify
softqcos config show

Global Flags

FlagShortDescription
--help-hShow help
--verbose-vVerbose output
--output-oOutput format: table (default), json, csv, yaml
--api-keyOverride API key
--base-urlOverride API base URL
--no-colorDisable colored output
--quiet-qMinimal output

softqcos config

Manage CLI configuration.

softqcos config show                          # Show current config
softqcos config set <key> <value> # Set config value
softqcos config get <key> # Get config value
softqcos config reset # Reset to defaults
softqcos config path # Show config file path

Configurable keys: api_key, base_url, output_format, timeout, color, verbose


softqcos jobs

Manage quantum jobs.

# Submit a job
softqcos jobs submit <qasm_file> --shots 1024 --backend aer_simulator

# List jobs
softqcos jobs list [--status pending|running|completed|failed] [--limit 50]

# Get job details
softqcos jobs get <job_id>

# Get results
softqcos jobs results <job_id> [-o json]

# Cancel a running job
softqcos jobs cancel <job_id>

# Wait for completion
softqcos jobs wait <job_id> [--timeout 300]

# Submit and wait (convenience)
softqcos jobs run <qasm_file> --shots 1024 --backend aer_simulator

# Get evidence
softqcos jobs evidence <job_id>

# Verify evidence
softqcos jobs verify <job_id>

# Get evidence bundle
softqcos jobs bundle <job_id>

Examples

# Simple execution
softqcos jobs run circuit.qasm --shots 4096

# Multi-backend comparison
for backend in aer_simulator ibm_brisbane ionq_harmony; do
softqcos jobs run circuit.qasm --shots 1024 --backend $backend -o json
done

# Get results as JSON
softqcos jobs results abc123 -o json | jq '.counts'

softqcos circuits

Circuit management.

softqcos circuits submit <qasm_file>                              # Submit circuit
softqcos circuits get <circuit_id> # Get circuit details
softqcos circuits list [--limit 50] # List circuits
softqcos circuits delete <circuit_id> # Delete circuit
softqcos circuits validate <qasm_file> # Validate QASM
softqcos circuits convert <qasm_file> --target qiskit|cirq|braket # Convert format
softqcos circuits stats <circuit_id> # Get statistics
softqcos circuits optimize <qasm_file> [--backend <backend>] # Optimize circuit
softqcos circuits simulate <qasm_file> --shots 1024 # Local simulation

softqcos backends

Backend discovery and BYOB management.

Discovery

softqcos backends list                                  # List all backends
softqcos backends get <backend_id> # Backend details
softqcos backends providers # List providers
softqcos backends all # All backends (all providers)

BYOB (Bring Your Own Backend)

softqcos backends add \
--name "my_simulator" \
--provider custom \
--endpoint https://my-backend.example.com \
--auth-token "token_..."

softqcos backends update <backend_id> --name "new_name"
softqcos backends delete <backend_id>
softqcos backends validate <backend_id> # Test connectivity
softqcos backends execute <backend_id> <qasm_file> --shots 1024

IBM Quantum

softqcos backends ibm list                              # IBM backends
softqcos backends ibm execute <qasm_file> --backend ibm_brisbane --shots 1024
softqcos backends ibm estimate <qasm_file> --backend ibm_brisbane
softqcos backends ibm status <job_id>
softqcos backends ibm cancel <job_id>

Azure Quantum

softqcos backends azure providers                       # Azure providers
softqcos backends azure targets # Azure targets
softqcos backends azure list # Azure backends
softqcos backends azure execute <qasm_file> --backend ionq.simulator --shots 1024
softqcos backends azure estimate <qasm_file> --backend ionq.simulator
softqcos backends azure status <job_id>
softqcos backends azure cancel <job_id>

AWS Braket

softqcos backends braket list                           # Braket backends
softqcos backends braket execute <qasm_file> --backend sv1 --shots 1024
softqcos backends braket estimate <qasm_file> --backend sv1
softqcos backends braket status <job_id>
softqcos backends braket cancel <job_id>

softqcos bench

Benchmarking suite.

softqcos bench run <backend> [--suite standard] [--shots 4096] [--reps 5]
softqcos bench report <benchmark_id>
softqcos bench download <benchmark_id> [--output report.pdf]
softqcos bench suites # List benchmark suites
softqcos bench suite <suite_id> # Suite details
softqcos bench workloads # Available workloads
softqcos bench verify <benchmark_id> # Verify integrity
softqcos bench health # Service health
softqcos bench selftest # Run self-test
softqcos bench metrics # Metrics coverage

Example

# Benchmark a backend
softqcos bench run ibm_brisbane --suite standard --shots 4096

# Download PDF report
softqcos bench download bench_abc123 --output brisbane_report.pdf

softqcos calibration

Device calibration and GlassBox™.

softqcos calibration health                             # Service health
softqcos calibration info # Service info
softqcos calibration devices # List devices
softqcos calibration state <device_name> # Device calibration state
softqcos calibration qubit <device_name> <qubit_id> # Qubit details
softqcos calibration compile <qasm_file> [--device <name>] # Calibration-aware compile
softqcos calibration compile-status <compilation_id> # Compilation status

# Evidence
softqcos calibration evidence create <device_name> # Create evidence bundle
softqcos calibration evidence get <bundle_id> # Get evidence
softqcos calibration evidence verify <bundle_id> # Verify evidence
softqcos calibration evidence sign <bundle_id> # Sign evidence
softqcos calibration evidence finalize <bundle_id> # Finalize evidence
softqcos calibration evidence audit <bundle_id> # Full audit trail

softqcos billing

Billing, pricing, and ROI Engine™.

softqcos billing providers                              # List providers
softqcos billing pricebook # Full pricebook
softqcos billing plans # Available plans
softqcos billing calculate \
--provider ibm \
--backend ibm_brisbane \
--shots 10000 \
--circuits 5

softqcos billing scenarios \
--backends ibm_brisbane,ionq_harmony \
--shots 1000,10000,100000 \
--circuits 5

softqcos billing compare [--shots 10000] # Compare all providers
softqcos billing report <backend> --format pdf|latex|json

softqcos network

QuantumNet™ quantum networking.

# Service
softqcos network health
softqcos network status
softqcos network topology
softqcos network backends

# Quantum operations
softqcos network entangle --node-a <id> --node-b <id> [--protocol bss]
softqcos network teleport --source <id> --target <id> --qubit <state>
softqcos network remote-cnot --control <id> --target <id>
softqcos network barrier --nodes <id1,id2,id3>

# Phase 0 research
softqcos network ion-species
softqcos network phase0-sweep --species <name> --param <p> --range <min:max:step>
softqcos network phase0b-analyze --sweep-id <id>
softqcos network phase0b-recommend --sweep-id <id>

# Network jobs
softqcos network jobs [--limit 50]
softqcos network job <job_id>
softqcos network job-result <job_id>
softqcos network job-evidence <job_id>

# Evidence
softqcos network evidence <evidence_id>
softqcos network evidence-bundle <job_id>

softqcos qec

QEC Runtime™ quantum error correction.

softqcos qec health
softqcos qec codes # List error correction codes
softqcos qec code <code_id> # Code details
softqcos qec create --type surface --distance 3 # Create code
softqcos qec decode --code <code_id> --syndrome <data>
softqcos qec syndrome --code <code_id> --measurement <data>
softqcos qec compile <qasm_file> --code <code_id>
softqcos qec pipeline <qasm_file> --code <code_id> --rounds 10

# Zones
softqcos qec zones
softqcos qec zone <zone_id>
softqcos qec zone-create --code <code_id> --qubits <q1,q2,q3>
softqcos qec zone-delete <zone_id>

# Certification
softqcos qec certify --code <code_id>
softqcos qec isolation-evidence <evidence_id>
softqcos qec certificates

softqcos isolation

ZoneGuard™ qubit isolation.

softqcos isolation health
softqcos isolation crosstalk # Crosstalk map
softqcos isolation zones # List zones
softqcos isolation zone <zone_id> # Zone details
softqcos isolation allocate --qubits <q1,q2,q3> --backend <name>
softqcos isolation execute <qasm_file> --zone <zone_id>
softqcos isolation delete <zone_id>
softqcos isolation evidence <evidence_id>

softqcos dri

Device Readiness Inspection.

# Assessment
softqcos dri health
softqcos dri run --backend <name> # Full DRI assessment
softqcos dri probe --backend <name> # Quick probe
softqcos dri list # List assessments
softqcos dri report <rating_id> # Detailed report
softqcos dri summary <rating_id> # Summary
softqcos dri evidence <bundle_id> # Evidence

# Proof-of-Quantum
softqcos dri proof run --backend <name>
softqcos dri proof get <test_id>
softqcos dri proof report <test_id>
softqcos dri proof cert <test_id> [--output cert.pdf]
softqcos dri proof compare --backends <b1,b2>
softqcos dri proof compare-result <comparison_id>
softqcos dri proof compare-cert <comparison_id> [--output comparison.pdf]

softqcos ledger

QuantumLedger™ metering and governance.

# Jobs & Usage
softqcos ledger jobs [--limit 50] [--tenant <id>]
softqcos ledger job <job_id>
softqcos ledger usage [--period month]
softqcos ledger provenance <job_id>

# Tenants
softqcos ledger tenants
softqcos ledger tenant <tenant_id>
softqcos ledger tenant-create --name "Team A" --budget 1000

# Budgets
softqcos ledger budgets [--tenant <id>]
softqcos ledger budget-create --tenant <id> --amount 500 --period monthly

# Projects
softqcos ledger projects
softqcos ledger project-create --name "Q-ML Research" --tenant <id>

# Pricing & Billing
softqcos ledger pricing
softqcos ledger estimate --backend <name> --shots 10000
softqcos ledger audit
softqcos ledger chargeback --tenant <id> --period 2024-01

softqcos navcore

NavCore™ quantum navigation (48 commands).

Core

softqcos navcore status
softqcos navcore algorithms
softqcos navcore navigate --lat <lat> --lon <lon> [--algorithm quantum]
softqcos navcore spoof-detect --signal <data>
softqcos navcore sensor-simulate --scenario <name>

QRNG

softqcos navcore qrng bytes --count 32
softqcos navcore qrng uuid
softqcos navcore qrng nonce

PQC

softqcos navcore pqc keypair --algorithm dilithium
softqcos navcore pqc sign --key <file> --message <data>
softqcos navcore pqc verify --key <file> --signature <sig> --message <data>

RAIM

softqcos navcore raim status
softqcos navcore raim threats
softqcos navcore raim process --observations <data>
softqcos navcore raim exclude --satellite <prn>
softqcos navcore raim statistics
softqcos navcore raim quantum-verify
softqcos navcore raim hybrid-fusion

Time

softqcos navcore time utc
softqcos navcore time network
softqcos navcore time sync --source <ntp_server>

Standards & Compliance

softqcos navcore sosa profiles
softqcos navcore sosa validate --profile <name> --data <file>
softqcos navcore victory services
softqcos navcore victory publish --service <name> --data <file>
softqcos navcore face status
softqcos navcore conformance report

HAL

softqcos navcore hal sensors
softqcos navcore hal register --sensor <name> --type <type> --endpoint <url>

Quantum Processing

softqcos navcore quantum status
softqcos navcore quantum process --data <file>
softqcos navcore quantum configure --param <key=value>
softqcos navcore quantum performance
softqcos navcore quantum sequences
softqcos navcore quantum circuit-run <qasm_file>
softqcos navcore noise characterize --backend <name>

Kalman Filter

softqcos navcore kalman update --measurement <data>
softqcos navcore kalman predict --steps 10
softqcos navcore kalman state
softqcos navcore kalman reset [--keep-state]

OSNMA

softqcos navcore osnma status
softqcos navcore osnma satellites
softqcos navcore osnma verify --signal <data>

NIS2 Compliance

softqcos navcore nis2 status
softqcos navcore nis2 gaps
softqcos navcore nis2 incident --type <type> --description "..."
softqcos navcore compliance audit
softqcos navcore compliance summary

softqcos acos

ACOS-ISA™ certification.

softqcos acos health
softqcos acos tiers # List certification tiers
softqcos acos tests # Available tests
softqcos acos certify <backend> [--tier bronze|silver|gold|platinum]
softqcos acos verify <certificate_id>
softqcos acos certificates # List certificates
softqcos acos certificate <certificate_id> # Certificate details
softqcos acos evidence <evidence_id>

softqcos macro

Quantum Macro™ analysis.

softqcos macro health
softqcos macro market-sizing [--industry <name>] # TAM/SAM analysis
softqcos macro energy-optimize --backend <name> # Energy optimization
softqcos macro risk-analysis --investment <amount> # ROI/risk scoring

softqcos evidence

Evidence management.

softqcos evidence artifacts <job_id>                    # List artifacts
softqcos evidence artifact <job_id> <artifact_name> # Get artifact
softqcos evidence capabilities <job_id> # Evidence capabilities
softqcos evidence download <job_id> [--output ./evidence/]
softqcos evidence verify <evidence_hash> # Verify integrity
softqcos evidence public-key # Get signing public key

softqcos admin

Platform administration (admin key required).

softqcos admin health                                   # /readiness + /liveness
softqcos admin tenants # List tenants
softqcos admin tenant-usage <tenant_id> # Tenant usage stats
softqcos admin metrics # Platform metrics
softqcos admin rate-limits # Rate limit config
softqcos admin circuit-breakers # Circuit breaker status
softqcos admin circuit-breaker-reset <service> # Reset circuit breaker
softqcos admin backends-status # Backend status summary
softqcos admin backend-capabilities <backend_id> # Backend capabilities

Environment Variables

VariableDescriptionDefault
QCOS_API_KEYAPI key
QCOS_BASE_URLBase URLhttps://api.softquantus.com
QCOS_TIMEOUTRequest timeout (seconds)30
QCOS_OUTPUTOutput formattable
QCOS_NO_COLORDisable colorsfalse
QCOS_VERBOSEVerbose modefalse

Shell Completions

# Bash
softqcos --install-completion bash

# Zsh
softqcos --install-completion zsh

# Fish
softqcos --install-completion fish

© 2024-2026 SoftQuantus Innovative OÜ. All Rights Reserved.