https://github.com/muench-dev/mage-remote-run
A tool to manage remote Adobe Commerce / Magento / Mage-OS instances from command line
https://github.com/muench-dev/mage-remote-run
Last synced: 4 months ago
JSON representation
A tool to manage remote Adobe Commerce / Magento / Mage-OS instances from command line
- Host: GitHub
- URL: https://github.com/muench-dev/mage-remote-run
- Owner: muench-dev
- Created: 2025-12-23T11:58:56.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-11T10:07:45.000Z (5 months ago)
- Last Synced: 2026-01-11T15:25:54.445Z (5 months ago)
- Language: JavaScript
- Size: 746 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Roadmap: ROADMAP.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Mage Remote Run
The remote swiss army knife for Magento Open Source, Mage-OS, Adobe Commerce
## Project Status
This tool is in an early stage and not yet stable. Expect breaking changes as the CLI evolves.
## Features
- **Connection Management**: Easily switch between multiple Magento instances (SaaS/PaaS).
- **Interactive Prompts**: User-friendly wizard for configuration and command inputs.
- **Rich Output**: Formatted tables and structured data display.
- **Interactive Console (REPL)**: Run CLI commands or JavaScript in a live session.
- **MCP Server**: Expose commands as MCP tools over stdio or HTTP (SSE).
- **Comprehensive API Support**:
- **Stores**: Manage websites, stores, and store views.
- **Customers**: List, search, show, and delete customers.
- **Orders**: View latest orders and order details.
- **Products**: Inspect product types and attributes.
- **Tax**: List tax classes.
## Installation
```bash
npm install -g mage-remote-run
```
Or run directly via `npx` without installation:
```bash
npx mage-remote-run [command]
```
## Usage
### Configuration
The CLI supports multiple profiles. You can configure them interactively.
1. **Add a Connection**:
```bash
node bin/mage-remote-run.js connection add
```
Follow the prompts to enter your instance URL and API credentials (Bearer Token).
2. **Select Active Profile**:
```bash
node bin/mage-remote-run.js connection select
```
3. **Check Status**:
```bash
node bin/mage-remote-run.js connection status
```
4. **Test Connections**:
```bash
node bin/mage-remote-run.js connection test --all
```
### Key Commands
- **Websites**:
```bash
node bin/mage-remote-run.js website list
node bin/mage-remote-run.js website search
```
- **Stores**:
```bash
node bin/mage-remote-run.js store list
node bin/mage-remote-run.js store view list
```
- **Customers**:
```bash
node bin/mage-remote-run.js customer list
node bin/mage-remote-run.js customer show
```
- **Orders**:
```bash
node bin/mage-remote-run.js order latest
node bin/mage-remote-run.js order show
```
### Interactive Console (REPL)
```bash
node bin/mage-remote-run.js console
# or
node bin/mage-remote-run.js repl
```
Inside the console, you can run commands directly (for example, `website list`) or evaluate JavaScript with top-level `await`.
### MCP Server
Expose the CLI as an MCP server:
```bash
node bin/mage-remote-run.js mcp --transport stdio
node bin/mage-remote-run.js mcp --transport http --host 127.0.0.1 --port 18098
```
Commands are registered as tools (for example, `website list` becomes `website_list`), and tool inputs map to the same CLI arguments and options.
## Development
### Testing
The project uses Jest for testing.
```bash
npm test
```
### Project Structure
- `bin/`: CLI entry point.
- `lib/commands/`: Command implementations.
- `lib/api/`: API client factory and logic.
- `tests/`: Unit and integration tests.