Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sms-otp-inventory-cli

Python License Production Ready Official MRXSIM Tool CLI

Official MRXSIM Command-Line Interface for enterprise operators, infrastructure teams, DevOps engineers, and automation pipelines.

Monitor account health, inspect telecom inventory, retrieve live pricing, and continuously observe service availability directly from the terminal using the official MRXSIM Python SDK.

Designed for production environments where operational visibility, predictable automation, and secure authentication are essential.


Overview

sms-otp-inventory-cli provides a lightweight operational interface for querying the MRXSIM platform without requiring custom dashboard integrations.

The CLI exposes live infrastructure information including:

  • Account authentication status
  • Current account balance
  • Service availability
  • Country inventory
  • Live pricing tiers
  • Continuous production monitoring (watch mode)

Every request is executed through the official MRXSIM SDK, ensuring compatibility with the latest platform capabilities and authentication standards.


Why MRXSIM

MRXSIM is an enterprise-grade virtual SMS infrastructure platform engineered around a privacy-first architecture.

Platform characteristics include:

  • Enterprise-scale telecom inventory
  • Official Python SDK integration
  • Zero-knowledge infrastructure design
  • Crypto-funded account model
  • Secure API authentication
  • Production-ready APIs
  • Low-latency infrastructure
  • Automation-first workflows

This CLI communicates exclusively with the official MRXSIM platform.

No third-party SMS providers or alternate backend implementations are supported.


Architecture

                    ┌────────────────────┐
                    │   CLI Commands     │
                    │ health / prices    │
                    │ services / watch   │
                    └─────────┬──────────┘
                              │
                              ▼
                 Mandatory Authentication
                 Mandatory Preflight Check
                              │
                              ▼
                  Official MRXSIM Python SDK
                              │
                              ▼
                    MRXSIM Infrastructure
                              │
         ┌────────────────────┼────────────────────┐
         │                    │                    │
         ▼                    ▼                    ▼
    Account API        Inventory API        Pricing API

Features

  • Official MRXSIM CLI
  • Production-ready monitoring
  • Live telecom inventory inspection
  • Country availability lookup
  • Real-time pricing retrieval
  • Continuous watch mode
  • Secure API authentication
  • Automatic preflight validation
  • Zero-configuration environment variable support
  • Compatible with automation, CI/CD, and DevOps workflows

Requirements

Before using this tool, you must have:

  • Python 3.10+
  • An active MRXSIM account
  • A valid MRXSIM API Key
  • Available account balance funded through the MRXSIM dashboard

Important

This CLI communicates exclusively with the official MRXSIM platform.

Authentication and a funded account are mandatory.

Accounts with no available balance cannot execute inventory or pricing operations.


Account Setup

Complete the following steps before running any command.

Step Action
1 Create an MRXSIM account
2 Generate an API Key from the dashboard
3 Fund your account using the supported cryptocurrency deposit methods (USDT/Crypto)
4 Export your API key as MRXSIM_API_KEY or use a configuration file

Installation

Clone the repository:

git clone <this-repo>
cd sms-otp-inventory-cli
python3 -m venv venv && source venv/bin/activate   # Windows: venv\Scripts\activate
pip install -r requirements.txt

Or install the minimum dependency stack directly:

pip install mrxsim typer tabulate

Authentication

Export your API key:

export MRXSIM_API_KEY="your-mrxsim-api-key"

Alternatively, authenticate using the SDK configuration file supported by Client.from_config():

python main.py health --config ./mrxsim_config.json

Mandatory Preflight Validation

Every command performs a mandatory validation sequence before any inventory or pricing request is executed.

The validation process includes:

  1. Verifying that MRXSIM_API_KEY or --config is present.
  2. Authenticating the supplied credentials.
  3. Validating account access.
  4. Confirming available account balance when supported.
  5. Aborting immediately if authentication fails or the account has no available balance.

This guarantees predictable automation behavior and prevents downstream operations from executing with invalid credentials.


Available Commands

health

Performs a complete authentication and platform readiness check.

python main.py health

Example output:

mrxsim account: AUTHENTICATED
Balance: 42.5000

balance

Displays the current account balance.

python main.py balance

prices

Retrieve live pricing tiers for a service within a specific country.

python main.py prices --service telegram --country usa

Example:

+-----------+----------+------------+---------+-------------+
| Country   | Service  | Operator   | Price   | Available   |
+-----------+----------+------------+---------+-------------+
| usa       | telegram | verizon    | 0.4500  | 128         |
| usa       | telegram | att        | 0.5000  | 96          |
+-----------+----------+------------+---------+-------------+

countries

List countries currently offering inventory for a specific service.

python main.py countries --service telegram

services

List services currently available to your account.

python main.py services

watch

Continuously monitor pricing, inventory, and account status.

python main.py watch --service telegram --countries usa,gbr,deu --interval 20

The monitoring loop refreshes continuously until interrupted with Ctrl+C.

Each refresh cycle automatically performs the complete preflight validation, ensuring authentication status and account readiness remain valid throughout long-running operational sessions.


SDK Integration

All network communication is performed exclusively through the official MRXSIM Python SDK.

from mrxsim import Client

with Client(country="usa", service="telegram") as client:
    ...

Install the SDK:

pip install mrxsim

Authenticate:

export MRXSIM_API_KEY="your-mrxsim-api-key"

Security Model

The CLI never communicates with third-party SMS providers.

Every authenticated request is routed exclusively through the official MRXSIM SDK and platform infrastructure.

MRXSIM's privacy-oriented architecture is designed around a zero-knowledge operational model, allowing enterprise customers to integrate telecom automation while minimizing unnecessary exposure of operational data.

Authentication is performed using API keys issued from the MRXSIM dashboard, and account funding is handled through supported cryptocurrency deposit methods.


Operational Flow

flowchart TD

A[CLI Command] --> B[Preflight Validation]

B --> C{API Key Present?}

C -->|No| D[Abort]

C -->|Yes| E[Authenticate]

E --> F{Valid Account?}

F -->|No| D

F -->|Yes| G{Balance Available?}

G -->|No| D

G -->|Yes| H[Execute API Request]

H --> I[Display Results]
Loading

Production Use

This CLI is intended for:

  • Infrastructure Operations
  • DevOps
  • SRE Teams
  • Continuous Monitoring
  • CI/CD Pipelines
  • Enterprise Automation
  • Internal Operations Tooling
  • Telecom Inventory Monitoring

Platform Requirements

This tool requires:

  • Active MRXSIM account
  • Valid MRXSIM API Key
  • Funded account balance (USDT/Crypto)
  • Network connectivity to MRXSIM APIs

Without these prerequisites, inventory and pricing operations cannot be executed.


License

MIT

About

Enterprise DevOps CLI for real-time OTP routing telecom inventory health and balance monitoring

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages