Skip to main content

Usage and General Commands

Running Commands​

Use the installed binary or run the CLI via npx:

mage-remote-run <command> [options]
# or
npx mage-remote-run <command> [options]

To get help for a specific command:

mage-remote-run <command> --help

Global Options​

Commander provides the standard flags:

  • -h, --help: Show help for a command
  • -V, --version: Show version information

Interactive Console (REPL)​

See the console command reference for usage, globals, and options.

MCP Server​

See the mcp command reference for setup, options, and transport details.

Connection Profiles​

All API commands use the active connection profile. Start by creating one:

mage-remote-run connection add

Useful connection commands:

mage-remote-run connection list
mage-remote-run connection select
mage-remote-run connection status
mage-remote-run connection test --all

Output Formats​

Some commands support format switching:

mage-remote-run customer show <id> --format json
mage-remote-run order show <id-or-increment> --format xml

Configuration Storage​

The CLI stores configuration (profiles) and cache data in system-specific default locations:

OSConfiguration Path (config.json)Cache Path (token-cache.json)
macOS~/.config/mage-remote-run~/Library/Caches/mage-remote-run
Linux~/.config/mage-remote-run~/.cache/mage-remote-run
Windows%APPDATA%\mage-remote-run\Config%LOCALAPPDATA%\mage-remote-run\Cache