CLI Command Manual

This page provides the full operational manual for key commands inside the softqcos suite. Use these commands to manage systems, execute workloads, inspect calibrations, and audit budgets.

1. Authentication & System Diagnostics

Initialize terminal credentials against the active identity router:

softqcos login --api-key "sq-live-your-key" --api-url "https://api.softquantus.com"

Flags:
- --api-key / -k: The organization Bearer token.
- --api-url / -u: Destination gateway router URL.

`softqcos doctor`

Verify local environment dependencies, clock skew, and internet availability:

softqcos doctor

Sample Output:

Checking local configurations... [OK]
Resolving API Gateway: https://api.softquantus.com... [CONNECTED]
Checking Clock Synchronization... [OK] (Skew: -0.002s)
Checking local license validation path... [OK] (~/.softqcos/license.qlicense)
Cryptographic ML-DSA verify capability... [PASSED]
Status: Fully Operational (Staging & Production-Ready)

2. Workload & QASM Execution

`softqcos jobs submit`

Submit raw OpenQASM circuits for processing:

softqcos jobs submit \
  --circuit input_state.qasm \
  --backend "rigetti.aspen_m3" \
  --shots 2048

Flags:
- --circuit / -q: Path to the OpenQASM circuit file.
- --backend / -b: Target execution engine (e.g., simulator_aer, rigetti.aspen_m3, ionq.aria). Default: simulator_aer.
- --shots / -s: Measurement shots (Default: 1024).

Real-QPU and priced submissions print an approval prompt: softqcos jobs approve JOB_ID --token APPROVAL_TOKEN.

`softqcos jobs`

Manage submitted workload runs:

# Get job queue/execution status
softqcos jobs status job_rigetti_8f92a1c

# Download completed result counts
softqcos jobs results job_rigetti_8f92a1c

# Cancel a queued job before it runs
softqcos jobs cancel job_rigetti_8f92a1c

3. Libraries & Algorithms

Execute standard quantum routines without hand-crafting low-level QASM circuits:

`softqcos algorithms grover`

Perform database lookup simulation using Grover’s search:

softqcos algorithms grover 1010 --qubits 4 --json

Parameters:
- TARGET (positional): Binary value to isolate in the search space.
- --qubits / -q: Register size (defaults to the target’s length).
- --shots / -s: Measurement shots.

`softqcos algorithms shor`

Simulate modular factoring math:

softqcos algorithms shor 15

4. Calibration & Quantum Error Correction

Verify and configure hardware mitigation metrics:

`softqcos calibration`

Retrieve device calibration state and qubit info:

softqcos calibration devices              # list calibrated devices
softqcos calibration device rigetti.aspen_m3

The device state includes per-qubit coherence figures (T1/T2) and gate fidelities as reported by the provider’s latest calibration.

`softqcos qec`

Extract and decode stabilizer syndromes to diagnose errors:

# Extract syndrome from a circuit under a code
softqcos qec syndrome --circuit bell.qasm --code surface_7

# List codes / run the full QEC pipeline
softqcos qec codes
softqcos qec pipeline --help

5. Ledger & Resource Budgeting

`softqcos ledger estimate`

Dry-run a computational task to determine its budget usage before submission:

softqcos ledger estimate --backend "ionq.aria" --shots 4096 --qubits 8

The estimate reports the credit reservation for the job; the submit response itself also carries credits_required and approval_required before anything runs.

`softqcos ledger usage`

Inspect organization resource utilization:

softqcos ledger usage

Related: softqcos ledger audit and softqcos ledger chargeback generate the corresponding reports.

Command Line

CLI Commands

CLI Command Manual

1. Authentication & System Diagnostics

`softqcos doctor`

2. Workload & QASM Execution

`softqcos jobs submit`

`softqcos jobs`

3. Libraries & Algorithms

`softqcos algorithms grover`

`softqcos algorithms shor`

4. Calibration & Quantum Error Correction

`softqcos calibration`

`softqcos qec`

5. Ledger & Resource Budgeting

`softqcos ledger estimate`

`softqcos ledger usage`

​CLI Command Manual

​1. Authentication & System Diagnostics

​softqcos login

​softqcos doctor

​2. Workload & QASM Execution

​softqcos jobs submit

​softqcos jobs

​3. Libraries & Algorithms

​softqcos algorithms grover

​softqcos algorithms shor

​4. Calibration & Quantum Error Correction

​softqcos calibration

​softqcos qec

​5. Ledger & Resource Budgeting

​softqcos ledger estimate

​softqcos ledger usage

CLI Command Manual

1. Authentication & System Diagnostics

`softqcos login`

`softqcos doctor`

2. Workload & QASM Execution

`softqcos jobs submit`

`softqcos jobs`

3. Libraries & Algorithms

`softqcos algorithms grover`

`softqcos algorithms shor`

4. Calibration & Quantum Error Correction

`softqcos calibration`

`softqcos qec`

5. Ledger & Resource Budgeting

`softqcos ledger estimate`

`softqcos ledger usage`