@openrfid/cli

Headless Command-Line Interface & CI/CD Runner for OpenRFID Simulator

🚀 Overview

@openrfid/cli is the zero-dependency headless command-line interface for the OpenRFID Simulator ecosystem. It enables developers, QA automation engineers, and DevOps pipelines to spin up virtual RFID readers, start tag inventory generation cycles, and expose simulated REST/WebSocket/MQTT interfaces directly from terminal or CI/CD scripts.

Developed & Maintained by RFID Software India Private Limited.

📦 Installation

# Global installation via npm
npm install -g @openrfid/cli

# Or run instantly without installation using npx
npx @openrfid/cli simulator start

⚡ Quickstart & CLI Commands

1. Start Headless Simulation Server

npx @openrfid/cli simulator start --port 3100 --websocket 3101

2. Generate Tag Pool

npx @openrfid/cli tags generate --count 500 --format sgtin-96 --output tags.json

3. Add Virtual Reader Instance

npx @openrfid/cli reader add --name "Warehouse-Gate-1" --antennas 4 --power 30

🧪 CI/CD Integration (GitHub Actions)

Add OpenRFID Simulator directly to your automated integration test pipelines:

steps:
  - name: Launch OpenRFID Simulation Server
    run: npx @openrfid/cli simulator start --detach

  - name: Run Enterprise App Integration Tests
    run: npm test

🌐 Monorepo Ecosystem

| Package | Description | | :--- | :--- | | @openrfid/core | Core EventBus, Config, & SQLite persistence | | @openrfid/simulator | High-throughput inventory simulation engine | | @openrfid/epc | EPC Gen2 memory bank encoders & decoders | | @openrfid/gs1 | GS1 SGTIN-96, GRAI-96, GIAI-96 encoders |

📄 License & Corporate Support

Licensed under the MIT License.
Brought to you by RFID Software India Private Limited.
For enterprise RFID middleware, hardware drivers, or custom protocol plugins, visit rfidsoftwares.com.