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

npm install -g mage-remote-run

Or run directly via npx without installation:

npx mage-remote-run [command]

Usage

Configuration

The CLI supports multiple profiles. You can configure them interactively.

1. Add a Connection:

   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:

   node bin/mage-remote-run.js connection select

3. Check Status:

   node bin/mage-remote-run.js connection status

4. Test Connections:

   node bin/mage-remote-run.js connection test --all

Key Commands

• Websites:

  node bin/mage-remote-run.js website list
  node bin/mage-remote-run.js website search <query>

• Stores:

  node bin/mage-remote-run.js store list
  node bin/mage-remote-run.js store view list

• Customers:

  node bin/mage-remote-run.js customer list
  node bin/mage-remote-run.js customer show <id>

• Orders:

  node bin/mage-remote-run.js order latest
  node bin/mage-remote-run.js order show <increment_id>

Interactive Console (REPL)

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:

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.

npm test

Project Structure

• bin/: CLI entry point.
• lib/commands/: Command implementations.
• lib/api/: API client factory and logic.
• tests/: Unit and integration tests.