mage-remote-run 0.1.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.
Files changed (21) hide show
  1. package/README.md +101 -0
  2. package/api-specs/2.4.8/swagger-paas.json +70180 -0
  3. package/api-specs/2.4.8/swagger-saas.json +58076 -0
  4. package/bin/mage-remote-run.js +61 -0
  5. package/lib/api/client.js +22 -0
  6. package/lib/api/factory.js +27 -0
  7. package/lib/api/paas.js +103 -0
  8. package/lib/api/saas.js +97 -0
  9. package/lib/api/spec-loader.js +23 -0
  10. package/lib/commands/connections.js +214 -0
  11. package/lib/commands/customers.js +196 -0
  12. package/lib/commands/eav.js +49 -0
  13. package/lib/commands/orders.js +247 -0
  14. package/lib/commands/products.js +133 -0
  15. package/lib/commands/stores.js +113 -0
  16. package/lib/commands/tax.js +46 -0
  17. package/lib/commands/websites.js +76 -0
  18. package/lib/config.js +54 -0
  19. package/lib/prompts.js +99 -0
  20. package/lib/utils.js +18 -0
  21. package/package.json +43 -0
package/README.md ADDED
@@ -0,0 +1,101 @@
1
+ # Mage Remote Run
2
+
3
+ The remote swiss army knife for Magento Open Source, Mage-OS, Adobe Commerce
4
+
5
+ ## Project Status
6
+
7
+ This tool is in an early stage and not yet stable. Expect breaking changes as the CLI evolves.
8
+
9
+ ## Features
10
+
11
+ - **Connection Management**: Easily switch between multiple Magento instances (SaaS/PaaS).
12
+ - **Interactive Prompts**: User-friendly wizard for configuration and command inputs.
13
+ - **Rich Output**: Formatted tables and structured data display.
14
+ - **Comprehensive API Support**:
15
+ - **Stores**: Manage websites, stores, and store views.
16
+ - **Customers**: List, search, show, and delete customers.
17
+ - **Orders**: View latest orders and order details.
18
+ - **Products**: Inspect product types and attributes.
19
+ - **Tax**: List tax classes.
20
+
21
+ ## Installation
22
+
23
+ ```bash
24
+ npm install -g mage-remote-run
25
+ ```
26
+
27
+ Or run directly via `npx` without installation:
28
+
29
+ ```bash
30
+ npx mage-remote-run [command]
31
+ ```
32
+
33
+ ## Usage
34
+
35
+ ### Configuration
36
+
37
+ The CLI supports multiple profiles. You can configure them interactively.
38
+
39
+ 1. **Add a Connection**:
40
+ ```bash
41
+ node bin/mage-remote-run.js connection add
42
+ ```
43
+ Follow the prompts to enter your instance URL and API credentials (Bearer Token).
44
+
45
+ 2. **Select Active Profile**:
46
+ ```bash
47
+ node bin/mage-remote-run.js connection select
48
+ ```
49
+
50
+ 3. **Check Status**:
51
+ ```bash
52
+ node bin/mage-remote-run.js connection status
53
+ ```
54
+
55
+ 4. **Test Connections**:
56
+ ```bash
57
+ node bin/mage-remote-run.js connection test --all
58
+ ```
59
+
60
+ ### Key Commands
61
+
62
+ - **Websites**:
63
+ ```bash
64
+ node bin/mage-remote-run.js website list
65
+ node bin/mage-remote-run.js website search <query>
66
+ ```
67
+
68
+ - **Stores**:
69
+ ```bash
70
+ node bin/mage-remote-run.js store list
71
+ node bin/mage-remote-run.js store view list
72
+ ```
73
+
74
+ - **Customers**:
75
+ ```bash
76
+ node bin/mage-remote-run.js customer list
77
+ node bin/mage-remote-run.js customer show <id>
78
+ ```
79
+
80
+ - **Orders**:
81
+ ```bash
82
+ node bin/mage-remote-run.js order latest
83
+ node bin/mage-remote-run.js order show <increment_id>
84
+ ```
85
+
86
+ ## Development
87
+
88
+ ### Testing
89
+
90
+ The project uses Jest for testing.
91
+
92
+ ```bash
93
+ npm test
94
+ ```
95
+
96
+ ### Project Structure
97
+
98
+ - `bin/`: CLI entry point.
99
+ - `lib/commands/`: Command implementations.
100
+ - `lib/api/`: API client factory and logic.
101
+ - `tests/`: Unit and integration tests.