@openrfid/cli 0.1.0 โ 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -0
- package/package.json +12 -11
package/README.md
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="https://raw.githubusercontent.com/rfidsoftwares/openrfid-simulator/main/assets/logo.svg" alt="OpenRFID Simulator Logo" width="180" />
|
|
4
|
+
|
|
5
|
+
# `@openrfid/cli`
|
|
6
|
+
|
|
7
|
+
### Headless Command-Line Interface & CI/CD Runner for OpenRFID Simulator
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@openrfid/cli)
|
|
10
|
+
[](https://opensource.org/licenses/MIT)
|
|
11
|
+
[](https://rfidsoftwares.com)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## ๐ Overview
|
|
18
|
+
|
|
19
|
+
`@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.
|
|
20
|
+
|
|
21
|
+
Developed & Maintained by **[RFID Software India Private Limited](https://rfidsoftwares.com)**.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## ๐ฆ Installation
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# Global installation via npm
|
|
29
|
+
npm install -g @openrfid/cli
|
|
30
|
+
|
|
31
|
+
# Or run instantly without installation using npx
|
|
32
|
+
npx @openrfid/cli simulator start
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## โก Quickstart & CLI Commands
|
|
38
|
+
|
|
39
|
+
### 1. Start Headless Simulation Server
|
|
40
|
+
```bash
|
|
41
|
+
npx @openrfid/cli simulator start --port 3100 --websocket 3101
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 2. Generate Tag Pool
|
|
45
|
+
```bash
|
|
46
|
+
npx @openrfid/cli tags generate --count 500 --format sgtin-96 --output tags.json
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### 3. Add Virtual Reader Instance
|
|
50
|
+
```bash
|
|
51
|
+
npx @openrfid/cli reader add --name "Warehouse-Gate-1" --antennas 4 --power 30
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## ๐งช CI/CD Integration (GitHub Actions)
|
|
57
|
+
|
|
58
|
+
Add OpenRFID Simulator directly to your automated integration test pipelines:
|
|
59
|
+
|
|
60
|
+
```yaml
|
|
61
|
+
steps:
|
|
62
|
+
- name: Launch OpenRFID Simulation Server
|
|
63
|
+
run: npx @openrfid/cli simulator start --detach
|
|
64
|
+
|
|
65
|
+
- name: Run Enterprise App Integration Tests
|
|
66
|
+
run: npm test
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## ๐ Monorepo Ecosystem
|
|
72
|
+
|
|
73
|
+
| Package | Description |
|
|
74
|
+
| :--- | :--- |
|
|
75
|
+
| [`@openrfid/core`](https://www.npmjs.com/package/@openrfid/core) | Core EventBus, Config, & SQLite persistence |
|
|
76
|
+
| [`@openrfid/simulator`](https://www.npmjs.com/package/@openrfid/simulator) | High-throughput inventory simulation engine |
|
|
77
|
+
| [`@openrfid/epc`](https://www.npmjs.com/package/@openrfid/epc) | EPC Gen2 memory bank encoders & decoders |
|
|
78
|
+
| [`@openrfid/gs1`](https://www.npmjs.com/package/@openrfid/gs1) | GS1 SGTIN-96, GRAI-96, GIAI-96 encoders |
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## ๐ License & Corporate Support
|
|
83
|
+
|
|
84
|
+
Licensed under the **MIT License**.
|
|
85
|
+
Brought to you by **RFID Software India Private Limited**.
|
|
86
|
+
For enterprise RFID middleware, hardware drivers, or custom protocol plugins, visit **[rfidsoftwares.com](https://rfidsoftwares.com)**.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openrfid/cli",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Headless CLI and terminal management tools for OpenRFID Simulator.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
"openrfid": "./dist/index.js"
|
|
9
9
|
},
|
|
10
10
|
"files": [
|
|
11
|
-
"dist"
|
|
11
|
+
"dist",
|
|
12
|
+
"README.md"
|
|
12
13
|
],
|
|
13
14
|
"dependencies": {
|
|
14
15
|
"chalk": "^4.1.2",
|
|
@@ -16,15 +17,15 @@
|
|
|
16
17
|
"commander": "^12.0.0",
|
|
17
18
|
"inquirer": "^8.2.6",
|
|
18
19
|
"ora": "^5.4.1",
|
|
19
|
-
"@openrfid/
|
|
20
|
-
"@openrfid/
|
|
21
|
-
"@openrfid/
|
|
22
|
-
"@openrfid/
|
|
23
|
-
"@openrfid/
|
|
24
|
-
"@openrfid/
|
|
25
|
-
"@openrfid/
|
|
26
|
-
"@openrfid/simulator": "
|
|
27
|
-
"@openrfid/websocket": "
|
|
20
|
+
"@openrfid/core": "1.0.0",
|
|
21
|
+
"@openrfid/mqtt": "1.0.0",
|
|
22
|
+
"@openrfid/rest": "1.0.0",
|
|
23
|
+
"@openrfid/hopeland-discovery": "1.0.0",
|
|
24
|
+
"@openrfid/readers": "1.0.0",
|
|
25
|
+
"@openrfid/plugin-api": "1.0.0",
|
|
26
|
+
"@openrfid/tags": "1.0.0",
|
|
27
|
+
"@openrfid/simulator": "1.0.0",
|
|
28
|
+
"@openrfid/websocket": "1.0.0"
|
|
28
29
|
},
|
|
29
30
|
"devDependencies": {
|
|
30
31
|
"@types/inquirer": "^8.2.10",
|