Metadata-Version: 2.4
Name: softqcos
Version: 3.5.0
Summary: SoftQCOS™ CLI - Command-Line Interface for Quantum Circuit Optimization Service
Project-URL: Homepage, https://softquantus.com
Project-URL: Documentation, https://docs.softquantus.com
Project-URL: Portal, https://platform.softquantus.com
Project-URL: License, https://softquantus.com/legal/license
Project-URL: EULA, https://softquantus.com/legal/eula
Author-email: SoftQuantus innovative OÜ <support@softquantus.com>
License: Proprietary - SoftQuantus innovative OÜ
Keywords: cli,optimization,qaoa,qiskit,quantum,quantum-computing,softqcos,vqe
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: httpx>=0.24.0
Requires-Dist: rich>=13.0.0
Requires-Dist: softqcos-sdk>=1.0.0
Requires-Dist: typer>=0.9.0
Description-Content-Type: text/markdown

# CLI-QCOS - QCOS™ Command Line Interface

[![PyPI version](https://badge.fury.io/py/softqcos.svg)](https://pypi.org/project/softqcos/)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: Proprietary](https://img.shields.io/badge/License-Proprietary-red.svg)](https://softquantus.com/legal/license)

**QCOS™ CLI** — Command-line interface for the Quantum Circuit Optimization Service by SoftQuantus.

## 📦 Installation

```bash
pip install softqcos
```

This will automatically install the `softqcos-sdk` dependency.

## 🚀 Quick Start

```bash
# Configure API access once. No shell export required.
softqcos login

# Verify local config and API connectivity
softqcos doctor

# Show the SoftQuantus product welcome screen
softqcos welcome

# Show help
softqcos --help

# Run GHZ state optimization
softqcosrun ghz --qubits 20 --max-iters 100

# Run benchmark
softqcosbenchmark --qubits 5,10,20,50 --backend aer

# Show version
softqcos --version

# Show system info
softqcos info
```

The CLI stores credentials in `~/.softqcos/config.json` with file mode `0600`.
`QCOS_API_KEY` and `QCOS_API_URL` still work and override the saved config for CI/CD jobs.

## 📋 Commands

### `softqcosrun`

Run quantum circuit optimization.

```bash
softqcosrun ghz --qubits 50 --max-iters 100 --backend aer
softqcosrun vqe --qubits 4 --cost energy
```

**Options:**
- `--qubits, -q`: Number of qubits (default: 10)
- `--max-iters, -i`: Maximum iterations (default: 100)
- `--backend, -b`: Backend (aer, cirq, pennylane, braket)
- `--method, -m`: Backend method (automatic, statevector, matrix_product_state)
- `--cost, -c`: Cost function (correlation, bitstring, hybrid)
- `--output, -o`: Save results to JSON file

### `softqcosbenchmark`

Run benchmarks across multiple qubit counts.

```bash
softqcosbenchmark --qubits 5,10,20,50 --backend aer --output results.json
```

### `softqcosinfo`

Show system and environment information.

```bash
softqcosinfo
```

### `softqcos login`

Configure the production API URL and API key interactively:

```bash
softqcos login
```

Non-interactive setup:

```bash
softqcos login \
  --api-url https://platform.softquantus.com \
  --api-key sq-live-...
```

Show config:

```bash
softqcos config
```

Reset config:

```bash
softqcos config --reset
```

Run diagnostics:

```bash
softqcos doctor
```

### `softqcos api`

Stable JSON-first commands for agents, MCP bridges, Cursor, Copilot, and scripts:

```bash
softqcos api workspace init --json
softqcos api workspace discover --json
softqcos api job validate --input jobs/bell.qcos.json --json
softqcos api job plan --input jobs/bell.qcos.json --json
softqcos api run local --input jobs/bell.qcos.json --json
softqcos api result summary --input results/<run_id>/summary.json --json
```

These commands return structured payloads with `status`, `capability`, `artifacts`,
`metrics`, and `next_actions` so AI agents can continue workflows reliably.

QCOS GPU planning commands:

```bash
softqcos api gpu detect --json
softqcos api gpu benchmark --input circuits/bell.qasm --json
softqcos api gpu engine-detect --json
softqcos api gpu estimate-memory --qubits 30 --precision fp64 --json
softqcos api gpu plan --input circuits/bell.qasm --json
softqcos api gpu simulate --input circuits/bell.qasm --fallback-aer --json
softqcos api backend plan --input circuits/bell.qasm --json
softqcos api backend compare --input circuits/bell.qasm --execute-aer --json
softqcos api hybrid detect --json
softqcos api hybrid qec-plan --code surface --distance 5 --rounds 3 --json
softqcos api qlink plan-feedback-loop --qpu lab-qpu-1 --latency-budget-us 100 --qec --json
```

### `softqcosversion`

Show version information.

```bash
softqcos--version
```

## 📄 License

QCOS™ is proprietary software by SoftQuantus innovative OÜ.

- **EULA:** https://softquantus.com/legal/eula
- **Terms:** https://softquantus.com/legal/terms
- **Privacy:** https://softquantus.com/legal/privacy

## 🏢 Company

**SoftQuantus innovative OÜ**
Registry Code: 17048927
Address: Veskiposti tn 2-1002, Tallinn, 10138, Estonia

## 📞 Contact

- **Support:** support@softquantus.com
- **Licensing:** licensing@softquantus.com
- **Legal:** legal@softquantus.com

---

© 2024-2025 SoftQuantus innovative OÜ. All Rights Reserved.
QCOS™ is a trademark of SoftQuantus innovative OÜ.
