QuantumLock™ CLI Reference

Command Line Interface Tool

The QuantumLock™ CLI is a powerful tool for administrators to manage quantum licenses via terminal.

Version 2.1.3

Current version with full license lifecycle management: generate, list, show, validate, revoke.

📦 Installation

Via PyPI (Recommended)

pip install quantumlock-cli

Via Portal Download

Go to portal.softquantus.com
Navigate to Downloads → CLI
Download the binary for your platform

Available Platforms

Platform	File
Linux ARM64	`quantumlock-linux-arm64`
Linux x86_64	`quantumlock-linux-x86_64`
macOS ARM64	`quantumlock-darwin-arm64`
Windows x64	`quantumlock-windows-x64.exe`

Verify Installation

quantumlock --version
# QuantumLock CLI 2.1.3

🔧 Configuration

Command: configure

Configures the CLI with your API credentials.

quantumlock configure

Interactive Flow:

QuantumLock™ CLI Configuration

Current API URL: https://api.quantumlock.softquantus.com
API URL [https://api.quantumlock.softquantus.com]:
No API key configured
API Key: ********

✓ Configuration saved!
Config file: /home/user/.quantumlock/config.json

Testing connection...
✓ Connected as: admin@acme.com
Plan: BUSINESS
Monthly limit: 100000

Environment Variables

export QUANTUMLOCK_API_KEY="your_api_key"
export QUANTUMLOCK_API_URL="https://api.quantumlock.softquantus.com"

Configuration File

Location: ~/.quantumlock/config.json

{
  "api_url": "https://api.quantumlock.softquantus.com",
  "api_key": "qlk_abc123..."
}

📋 Commands Overview

quantumlock --help

Usage: quantumlock [OPTIONS] COMMAND [ARGS]...

QuantumLock™ CLI - Quantum-enhanced license management

Options:
  --version  Show version and exit
  --help     Show this message and exit

Commands:
  configure  Configure API credentials
  generate   Generate a new license
  validate   Validate a license key
  list       List all licenses
  show       Show license details
  revoke     Revoke a license
  stats      Show usage statistics
  info       Show account information
  version    Show version information

🔑 Generate License

Command: generate

Generates a new quantum license.

quantumlock generate [OPTIONS]

Options:

Option	Short	Required	Description
`--customer`	`-c`	✓	End-customer ID (email or unique ID)
`--features`	`-f`	✓	Comma-separated features
`--days`	`-d`		Validity in days (default: 365)
`--metadata`	`-m`		Metadata key=value (repeatable)
`--output`	`-o`		Save to JSON file

Examples:

# Basic license
quantumlock generate \
    --customer "customer@company.com" \
    --features "basic"

# License with multiple features
quantumlock generate \
    --customer "enterprise@acme.com" \
    --features "premium,api_access,analytics" \
    --days 365

# License with metadata
quantumlock generate \
    --customer "user@startup.io" \
    --features "enterprise,unlimited" \
    --days 730 \
    --metadata "company=StartupIO" \
    --metadata "department=Engineering" \
    --output license.json

Output:

Generating license...
Customer: customer@company.com
Features: premium, api_access
Expires in: 365 days

✓ License generated successfully!

┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Field             ┃ Value                                ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ License Key       │ QCOS-7A3F-9B2C-4E1D-8F5A-2B1C       │
│ Customer ID       │ customer@company.com                 │
│ Features          │ premium, api_access                  │
│ Issued At         │ 2026-01-03T20:15:00Z                 │
│ Expires At        │ 2027-01-03T20:15:00Z                 │
│ Quantum Fidelity  │ 0.9987                               │
│ Generation Time   │ 45ms                                 │
└───────────────────┴──────────────────────────────────────┘

✓ Saved to: license.json

✅ Validate License

Command: validate

Validates a license key.

quantumlock validate LICENSE_KEY

Examples:

# Validate license key
quantumlock validate "QCOS-7A3F-9B2C-4E1D-8F5A-2B1C"

Output (Valid):

Validating license...
License: QCOS-7A3F-9B2C-4E1D-8F5A-2B1C

✓ License is VALID

┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Field             ┃ Value                                ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ Customer ID       │ acme_corp                            │
│ End Customer      │ customer@company.com                 │
│ Features          │ premium, api_access                  │
│ Issued At         │ 2026-01-03T20:15:00Z                 │
│ Expires At        │ 2027-01-03T20:15:00Z                 │
│ Days Remaining    │ 365                                  │
│ Quantum Verified  │ ✓ Yes                                │
└───────────────────┴──────────────────────────────────────┘

Output (Invalid):

Validating license...
License: QCOS-XXXX-XXXX-XXXX

✗ License is INVALID
The license may be expired, revoked, or forged.

📋 List Licenses

Command: list

Lists all generated licenses with pagination and filters.

quantumlock list [OPTIONS]

Options:

Option	Short	Default	Description
`--page`	`-p`	1	Page number
`--limit`	`-l`	20	Items per page
`--status`	`-s`		Filter: active, expired, revoked
`--customer`	`-c`		Filter by customer ID

Examples:

# List all licenses
quantumlock list

# List only active licenses
quantumlock list --status active

# List with pagination
quantumlock list --page 2 --limit 50

# Filter by customer
quantumlock list --customer "user@company.com"

Output:

Fetching licenses...

                    Licenses (Page 1/5)
┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓
┃ License Key            ┃ Customer         ┃ Features   ┃ Status  ┃ Expires    ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩
│ QCOS-7A3F-9B2C-4E1D... │ customer@acme... │ premium... │ ACTIVE  │ 2027-01-03 │
│ QCOS-8B4G-0C3D-5F2E... │ user@startup.io  │ basic      │ ACTIVE  │ 2026-06-15 │
│ QCOS-9C5H-1D4E-6G3F... │ dev@company.com  │ enterprise │ EXPIRED │ 2025-12-01 │
│ QCOS-1A2B-3C4D-5E6F... │ test@demo.com    │ trial      │ REVOKED │ 2026-03-15 │
└────────────────────────┴──────────────────┴────────────┴─────────┴────────────┘

Showing 20 of 95 licenses
Use --page 2 to see more

🔍 Show License Details

Command: show

Shows detailed information about a specific license.

quantumlock show LICENSE_KEY [OPTIONS]

Options:

Option	Short	Description
`--output`	`-o`	Save details to JSON file

Examples:

# Show license details
quantumlock show "QCOS-7A3F-9B2C-4E1D-8F5A-2B1C"

# Save to file
quantumlock show "QCOS-7A3F-9B2C-4E1D-8F5A-2B1C" --output license_details.json

Output:

Fetching license details...

                    License Details
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Field             ┃ Value                                    ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ License Key       │ QCOS-7A3F-9B2C-4E1D-8F5A-2B1C           │
│ Status            │ ACTIVE                                   │
│ End Customer      │ customer@company.com                     │
│ Features          │ premium, api_access, analytics           │
│ Issued At         │ 2026-01-03T20:15:00Z                     │
│ Expires At        │ 2027-01-03T20:15:00Z                     │
│ Quantum Fidelity  │ 0.9987                                   │
│ Generation Time   │ 45ms                                     │
└───────────────────┴──────────────────────────────────────────┘

Output (Revoked License):

                    License Details
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Field             ┃ Value                                    ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ License Key       │ QCOS-1A2B-3C4D-5E6F-7G8H-9I0J           │
│ Status            │ REVOKED                                  │
│ End Customer      │ former@customer.com                      │
│ Features          │ premium                                  │
│ Issued At         │ 2025-06-01T10:00:00Z                     │
│ Expires At        │ 2026-06-01T10:00:00Z                     │
│                   │                                          │
│ Revoked At        │ 2026-01-02T14:30:00Z                     │
│ Revoke Reason     │ Customer cancelled subscription          │
└───────────────────┴──────────────────────────────────────────┘

❌ Revoke License

Command: revoke

Revokes an existing license. This action cannot be undone.

quantumlock revoke LICENSE_KEY [OPTIONS]

Options:

Option	Short	Description
`--reason`	`-r`	Reason for revocation
`--force`	`-f`	Skip confirmation prompt

Examples:

# Revoke with confirmation
quantumlock revoke "QCOS-7A3F-9B2C-4E1D-8F5A-2B1C"

# Revoke with reason
quantumlock revoke "QCOS-7A3F-9B2C-4E1D-8F5A-2B1C" \
    --reason "Customer cancelled subscription"

# Force revoke (no confirmation)
quantumlock revoke "QCOS-7A3F-9B2C-4E1D-8F5A-2B1C" \
    --reason "Fraudulent activity" \
    --force

Output:

Revoking license...
License: QCOS-7A3F-9B2C-4E1D-8F5A-2B1C

Warning: This action cannot be undone!
Are you sure you want to revoke this license? (y/N): y

✓ License revoked successfully!

License Key: QCOS-7A3F-9B2C-4E1D-8F5A-2B1C
Revoked At: 2026-01-03T20:30:00Z
Reason: Customer cancelled subscription

📊 Statistics

Command: stats

Shows account usage statistics.

quantumlock stats

Output:

Fetching statistics...

Account: admin@acme.com
Plan: BUSINESS

              License Statistics
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓
┃ Metric               ┃              Value ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩
│ Total Licenses       │              4,523 │
│ Active Licenses      │              4,100 │
│ Expired Licenses     │                400 │
│ This Month           │        4,523/100,000 │
│ Usage                │              4.5%  │
│                      │                    │
│ Avg Quantum Fidelity │             0.9987 │
│ Avg Generation Time  │               45ms │
└──────────────────────┴────────────────────┘

ℹ️ Account Info

Command: info

Shows your account information.

quantumlock info

Output:

Fetching account info...

              Account Information
┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Field           ┃ Value                          ┃
┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ Customer ID     │ cust_abc123                    │
│ Email           │ admin@acme.com                 │
│ Company         │ ACME Corporation               │
│ Plan            │ BUSINESS                       │
│ Monthly Limit   │ 100,000                        │
│ Used This Month │ 4,523                          │
│ Created At      │ 2025-01-15T10:00:00Z           │
└─────────────────┴────────────────────────────────┘

🔄 Exit Codes

Code	Meaning
0	Success
1	General error
2	Invalid license
3	API Key not configured
4	Connection error

💡 Usage Examples

Automation Script

#!/bin/bash
# Batch license generation

CUSTOMERS=(
    "customer1@company.com"
    "customer2@company.com"
    "customer3@company.com"
)

mkdir -p licenses

for customer in "${CUSTOMERS[@]}"; do
    echo "Generating license for: $customer"
    quantumlock generate \
        --customer "$customer" \
        --features "premium,api_access" \
        --days 365 \
        --output "licenses/${customer}.json"
done

echo "Done! Licenses saved in ./licenses/"

CI/CD Integration

# .github/workflows/deploy.yml
name: Deploy with License

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install QuantumLock CLI
        run: pip install quantumlock-cli

      - name: Generate deployment license
        env:
          QUANTUMLOCK_API_KEY: ${{ secrets.QUANTUMLOCK_API_KEY }}
        run: |
          quantumlock generate \
            --customer "deploy-${{ github.sha }}" \
            --features "ci_cd,deploy" \
            --days 1 \
            --output deployment_license.json

      - name: Deploy application
        run: |
          cp deployment_license.json /app/license.json
          # ... rest of deployment

License Cleanup Script

#!/bin/bash
# Revoke expired trial licenses

# Get all revoked licenses
quantumlock list --status expired --limit 100 | while read line; do
    license_key=$(echo "$line" | awk '{print $1}')
    if [[ $license_key == QCOS-* ]]; then
        echo "Revoking: $license_key"
        quantumlock revoke "$license_key" \
            --reason "Trial expired - automatic cleanup" \
            --force
    fi
done

Health Check Script

#!/bin/bash
# check_license.sh - Pre-startup license validation

LICENSE_KEY="$1"

if [ -z "$LICENSE_KEY" ]; then
    echo "❌ Usage: $0 <license_key>"
    exit 1
fi

if quantumlock validate "$LICENSE_KEY" > /dev/null 2>&1; then
    echo "✓ License valid, starting application..."
    exec /app/myapp
else
    echo "❌ License invalid or expired!"
    quantumlock show "$LICENSE_KEY" 2>/dev/null
    exit 2
fi

🔧 Troubleshooting

Error: "No API key configured"

# Solution 1: Configure via CLI
quantumlock configure

# Solution 2: Via environment variable
export QUANTUMLOCK_API_KEY="your_api_key"

Error: "Connection refused"

# Check API URL
cat ~/.quantumlock/config.json

# Test connection
curl -I https://api.quantumlock.softquantus.com/health

Error: "License not found"

The license key doesn't exist or belongs to another customer. Verify:

The license key is correct
You're using the right API key

Error: "License is already revoked"

The license has already been revoked. Use quantumlock show to see details.

Error: "Rate limit exceeded"

You've reached your plan's monthly limit. Options:

Wait for next month
Upgrade your plan at portal.softquantus.com
Contact support

Command Line Interface Tool​

📦 Installation​

Via PyPI (Recommended)​

Via Portal Download​

Available Platforms​

Verify Installation​

🔧 Configuration​

Command: configure​

Environment Variables​

Configuration File​

📋 Commands Overview​

🔑 Generate License​

Command: generate​

✅ Validate License​

Command: validate​

📋 List Licenses​

Command: list​

🔍 Show License Details​

Command: show​

❌ Revoke License​

Command: revoke​

📊 Statistics​

Command: stats​

ℹ️ Account Info​

Command: info​

🔄 Exit Codes​

💡 Usage Examples​

Automation Script​

CI/CD Integration​

License Cleanup Script​

Health Check Script​

🔧 Troubleshooting​

Error: "No API key configured"​

Error: "Connection refused"​

Error: "License not found"​

Error: "License is already revoked"​

Error: "Rate limit exceeded"​

📞 Support​

Command Line Interface Tool

📦 Installation

Via PyPI (Recommended)

Via Portal Download

Available Platforms

Verify Installation

🔧 Configuration

Command: configure

Environment Variables

Configuration File

📋 Commands Overview

🔑 Generate License

Command: generate

✅ Validate License

Command: validate

📋 List Licenses

Command: list

🔍 Show License Details

Command: show

❌ Revoke License

Command: revoke

📊 Statistics

Command: stats

ℹ️ Account Info

Command: info

🔄 Exit Codes

💡 Usage Examples

Automation Script

CI/CD Integration

License Cleanup Script

Health Check Script

🔧 Troubleshooting

Error: "No API key configured"

Error: "Connection refused"

Error: "License not found"

Error: "License is already revoked"

Error: "Rate limit exceeded"

📞 Support