mage-remote-run 0.9.0 → 0.11.0

package/lib/commands/adobe-io-events.js

@@ -8,6 +8,11 @@ export function registerAdobeIoEventsCommands(program) {
     adobeIoEvents.command('check-configuration')
         .description('Check Adobe I/O Event configuration')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run adobe-io-event check-configuration
+  $ mage-remote-run adobe-io-event check-configuration --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();

package/lib/commands/company.js

@@ -12,6 +12,13 @@ export function registerCompanyCommands(program) {
         .option('--sort-by <field>', 'Field to sort by', 'entity_id')
         .option('--sort-order <order>', 'Sort order (ASC, DESC)', 'ASC')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run company list
+  $ mage-remote-run company list --page 2 --size 50
+  $ mage-remote-run company list --sort-by company_name --sort-order DESC
+  $ mage-remote-run company list --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -52,6 +59,11 @@ export function registerCompanyCommands(program) {
     company.command('show <companyId>')
         .description('Show company details')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run company show 123
+  $ mage-remote-run company show 123 --format json
+`)
         .action(async (companyId, options) => {
             try {
                 const client = await createClient();

package/lib/commands/connections.js

@@ -6,11 +6,66 @@ import { input, confirm, select } from '@inquirer/prompts';
 import inquirer from 'inquirer';
 import chalk from 'chalk';
 
+// Helper to handle interactive connection configuration and testing
+async function configureAndTestConnection(name, initialSettings = {}) {
+    let settings = await askForProfileSettings(initialSettings);
+
+    while (true) {
+        const shouldTest = await confirm({
+            message: 'Test connection?',
+            default: true
+        });
+
+        if (shouldTest) {
+            console.log(chalk.blue(`\nTesting connection "${name}"...`));
+            try {
+                const client = await createClient(settings);
+                const start = Date.now();
+                await client.get('V1/store/storeViews');
+                const duration = Date.now() - start;
+                console.log(chalk.green(`✔ Connection successful! (${duration}ms)`));
+                break; // Test passed, proceed to save
+            } catch (e) {
+                console.error(chalk.red(`✖ Connection failed: ${e.message}`));
+                const shouldEdit = await confirm({
+                    message: 'Connection failed. Do you want to change settings?',
+                    default: true
+                });
+
+                if (shouldEdit) {
+                    // Re-ask for settings using current values as defaults
+                    settings = await askForProfileSettings(settings);
+                    continue; // Loop back to test
+                } else {
+                    // If they don't want to edit, ask if they want to save anyway
+                    const saveAnyway = await confirm({
+                        message: 'Save configuration anyway?',
+                        default: false
+                    });
+                    if (!saveAnyway) {
+                        return null;
+                    }
+                    break; // Break to save
+                }
+            }
+        } else {
+            // User skipped test, save
+            break;
+        }
+    }
+    return settings;
+}
+
+
 export function registerConnectionCommands(program) {
     const connections = program.command('connection').description('Manage mage-remote-run connection profiles');
 
     connections.command('add')
         .description('Configure a new connection profile')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection add
+`)
         .action(async () => {
             console.log(chalk.blue('Configure a new connection Profile'));
             try {
@@ -19,7 +74,11 @@ export function registerConnectionCommands(program) {
                     validate: value => value ? true : 'Name is required'
                 });
 
-                const settings = await askForProfileSettings();
+                const settings = await configureAndTestConnection(name);
+                if (!settings) {
+                    console.log(chalk.yellow('\nConfiguration cancelled.'));
+                    return;
+                }
 
                 await addProfile(name, settings);
                 console.log(chalk.green(`\nProfile "${name}" saved successfully!`));
@@ -49,6 +108,10 @@ export function registerConnectionCommands(program) {
 
     connections.command('list')
         .description('List connection profiles')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection list
+`)
         .action(async () => {
             try {
                 const config = await loadConfig();
@@ -64,6 +127,10 @@ export function registerConnectionCommands(program) {
 
     connections.command('search <query>')
         .description('Search connection profiles')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection search production
+`)
         .action(async (query) => {
             try {
                 const config = await loadConfig();
@@ -75,6 +142,10 @@ export function registerConnectionCommands(program) {
 
     connections.command('delete <name>')
         .description('Delete a connection profile')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection delete "Production"
+`)
         .action(async (name) => {
             try {
                 const config = await loadConfig();
@@ -90,15 +161,40 @@ export function registerConnectionCommands(program) {
             } catch (e) { handleError(e); }
         });
 
-    connections.command('edit <name>')
+    connections.command('edit [name]')
         .description('Edit a connection profile')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection edit
+  $ mage-remote-run connection edit "Production"
+`)
         .action(async (name) => {
             try {
                 const config = await loadConfig();
+                const profiles = Object.keys(config.profiles || {});
+
+                if (profiles.length === 0) {
+                    console.log(chalk.yellow('No profiles found to edit.'));
+                    return;
+                }
+
+                if (!name) {
+                    name = await select({
+                        message: 'Select Profile to Edit:',
+                        choices: profiles.map(p => ({ value: p, name: p }))
+                    });
+                }
+
                 const profile = config.profiles[name];
                 if (!profile) throw new Error(`Profile ${name} not found`);
 
-                const settings = await askForProfileSettings(profile);
+                console.log(chalk.blue(`Editing profile "${name}"`));
+
+                const settings = await configureAndTestConnection(name, profile);
+                if (!settings) {
+                    console.log(chalk.yellow('\nEdit cancelled.'));
+                    return;
+                }
 
                 config.profiles[name] = settings;
                 await saveConfig(config);
@@ -115,6 +211,11 @@ export function registerConnectionCommands(program) {
     connections.command('test')
         .description('Test connection(s)')
         .option('--all', 'Test all configured connections')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection test
+  $ mage-remote-run connection test --all
+`)
         .action(async (options) => {
             try {
                 const config = await loadConfig();
@@ -171,6 +272,10 @@ export function registerConnectionCommands(program) {
         });
     connections.command('status')
         .description('Show current configuration status')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection status
+`)
         .action(async () => {
             try {
                 const config = await loadConfig();
@@ -190,7 +295,13 @@ export function registerConnectionCommands(program) {
         });
 
     connections.command('select')
-        .description('Select the active connection profile')
+        .description('Select the active connection profile (aliases: change, switch)')
+        .aliases(['switch', 'change'])
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection select
+  $ mage-remote-run connection switch
+`)
         .action(async () => {
             try {
                 const config = await loadConfig();
@@ -214,6 +325,10 @@ export function registerConnectionCommands(program) {
 
     connections.command('clear-token-cache')
         .description('Clear cached access tokens')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection clear-token-cache
+`)
         .action(async () => {
             try {
                 await clearTokenCache();
@@ -223,6 +338,11 @@ export function registerConnectionCommands(program) {
 
     connections.command('status-header <state>')
         .description('Enable or disable the active connection header (on|off)')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run connection status-header on
+  $ mage-remote-run connection status-header off
+`)
         .action(async (state) => {
             try {
                 if (state !== 'on' && state !== 'off') {

package/lib/commands/customers.js

@@ -11,6 +11,12 @@ export function registerCustomersCommands(program) {
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run customer list
+  $ mage-remote-run customer list --page 2 --size 50
+  $ mage-remote-run customer list --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -41,6 +47,10 @@ export function registerCustomersCommands(program) {
 
     customers.command('search <query>')
         .description('Search customers by email')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run customer search "john@example.com"
+`)
         .action(async (query) => {
             try {
                 const client = await createClient();
@@ -56,6 +66,11 @@ export function registerCustomersCommands(program) {
         });
 
     customers.command('edit <id>')
+        .description('Edit a customer')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run customer edit 123
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();
@@ -84,6 +99,11 @@ export function registerCustomersCommands(program) {
     customers.command('show <customerId>')
         .description('Show detailed customer information')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run customer show 123
+  $ mage-remote-run customer show 123 --format json
+`)
         .action(async (customerId, options) => {
             try {
                 const client = await createClient();
@@ -139,6 +159,11 @@ export function registerCustomersCommands(program) {
     customers.command('delete <customerId>')
         .description('Delete a customer')
         .option('--force', 'Force delete without confirmation')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run customer delete 123
+  $ mage-remote-run customer delete 123 --force
+`)
         .action(async (customerId, options) => {
             try {
                 if (!options.force) {
@@ -163,6 +188,12 @@ export function registerCustomersCommands(program) {
     customers.command('confirm [customerId]')
         .description('Resend customer confirmation email')
         .option('--redirect-url <url>', 'Redirect URL after confirmation')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run customer confirm 123
+  $ mage-remote-run customer confirm 123 --redirect-url "https://example.com/login"
+  $ mage-remote-run customer confirm
+`)
         .action(async (customerId, options) => {
             try {
                 const client = await createClient();
@@ -215,6 +246,11 @@ export function registerCustomersCommands(program) {
         .description('List customer groups')
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run customer group list
+  $ mage-remote-run customer group list --page 1 --size 50
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();

package/lib/commands/eav.js

@@ -13,6 +13,11 @@ export function registerEavCommands(program) {
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run eav attribute-set list
+  $ mage-remote-run eav attribute-set list --page 1 --size 50
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -48,6 +53,10 @@ export function registerEavCommands(program) {
 
     attributeSets.command('show <id>')
         .description('Show attribute set details')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run eav attribute-set show 4
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();

package/lib/commands/inventory.js

@@ -10,6 +10,10 @@ export function registerInventoryCommands(program) {
 
     stock.command('list')
         .description('List inventory stocks')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run inventory stock list
+`)
         .action(async () => {
             try {
                 const client = await createClient();
@@ -26,6 +30,10 @@ export function registerInventoryCommands(program) {
 
     stock.command('show <stockId>')
         .description('Show stock details')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run inventory stock show 1
+`)
         .action(async (stockId) => {
             try {
                 const client = await createClient();
@@ -46,6 +54,10 @@ export function registerInventoryCommands(program) {
 
     inventory.command('resolve-stock <type> <code>')
         .description('Resolve stock for a sales channel')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run inventory resolve-stock website base
+`)
         .action(async (type, code) => {
             try {
                 const client = await createClient();
@@ -61,6 +73,11 @@ export function registerInventoryCommands(program) {
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run inventory source list
+  $ mage-remote-run inventory source list --page 1 --size 50
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -93,6 +110,10 @@ export function registerInventoryCommands(program) {
 
     ssa.command('list')
         .description('List available source selection algorithms')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run inventory source selection-algorithm list
+`)
         .action(async () => {
             try {
                 const client = await createClient();

package/lib/commands/orders.js

@@ -10,6 +10,12 @@ export function registerOrdersCommands(program) {
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run order list
+  $ mage-remote-run order list --page 1 --size 10
+  $ mage-remote-run order list --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -40,6 +46,10 @@ export function registerOrdersCommands(program) {
 
     orders.command('search <query>')
         .description('Search orders by Increment ID')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run order search 000000001
+`)
         .action(async (query) => {
             try {
                 const client = await createClient();
@@ -56,6 +66,10 @@ export function registerOrdersCommands(program) {
 
     orders.command('edit <id>')
         .description('Update order status (via Comment)')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run order edit 123
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();
@@ -81,6 +95,11 @@ export function registerOrdersCommands(program) {
     orders.command('show <identifier>')
         .description('Show detailed order information by ID or Increment ID')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run order show 123
+  $ mage-remote-run order show 000000001
+`)
         .action(async (identifier, options) => {
             try {
                 await showOrder(identifier, options.format);
@@ -92,6 +111,11 @@ export function registerOrdersCommands(program) {
         .option('-p, --page <number>', 'Page number', '1')
         .option('-z, --size <number>', 'Page size', '20')
         .option('-s, --select', 'Interactive selection mode')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run order latest
+  $ mage-remote-run order latest --size 5 --select
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();

package/lib/commands/products.js

@@ -12,6 +12,12 @@ export function registerProductsCommands(program) {
         .option('--sort-by <field>', 'Field to sort by', 'entity_id')
         .option('--sort-order <order>', 'Sort order (ASC, DESC)', 'ASC')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run product list
+  $ mage-remote-run product list --page 2 --size 50
+  $ mage-remote-run product list --sort-by price --sort-order DESC
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -45,6 +51,11 @@ export function registerProductsCommands(program) {
     products.command('show <sku>')
         .description('Show product details')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run product show SKU123
+  $ mage-remote-run product show SKU123 --format json
+`)
         .action(async (sku, options) => {
             try {
                 const client = await createClient();
@@ -156,6 +167,10 @@ export function registerProductsCommands(program) {
 
     types.command('list')
         .description('List available product types')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run product type list
+`)
         .action(async () => {
             try {
                 const client = await createClient();
@@ -171,6 +186,11 @@ export function registerProductsCommands(program) {
         .description('List product attributes')
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run product attribute list
+  $ mage-remote-run product attribute list --page 1 --size 50
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -196,6 +216,10 @@ export function registerProductsCommands(program) {
     attributes.command('show <attributeCode>')
         .description('Show product attribute details')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run product attribute show color
+`)
         .action(async (attributeCode, options) => {
             try {
                 const client = await createClient();
@@ -271,6 +295,10 @@ export function registerProductsCommands(program) {
     const attributeTypes = attributes.command('type').description('Manage attribute types');
     attributeTypes.command('list')
         .description('List product attribute types')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run product attribute type list
+`)
         .action(async () => {
             try {
                 const client = await createClient();

package/lib/commands/stores.js

@@ -12,6 +12,11 @@ export function registerStoresCommands(program) {
     groups.command('list')
         .description('List store groups')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store group list
+  $ mage-remote-run store group list --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -37,6 +42,10 @@ export function registerStoresCommands(program) {
 
     groups.command('search <query>')
         .description('Search store groups')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store group search "Main"
+`)
         .action(async (query) => {
             try {
                 const client = await createClient();
@@ -49,6 +58,10 @@ export function registerStoresCommands(program) {
 
     groups.command('delete <id>')
         .description('Delete store group')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store group delete 2
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();
@@ -61,6 +74,10 @@ export function registerStoresCommands(program) {
 
     groups.command('edit <id>')
         .description('Edit store group')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store group edit 2
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();
@@ -85,6 +102,11 @@ export function registerStoresCommands(program) {
     views.command('list')
         .description('List store views')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store view list
+  $ mage-remote-run store view list --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -110,6 +132,10 @@ export function registerStoresCommands(program) {
 
     views.command('search <query>')
         .description('Search store views')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store view search "default"
+`)
         .action(async (query) => {
             try {
                 const client = await createClient();
@@ -122,6 +148,10 @@ export function registerStoresCommands(program) {
 
     views.command('delete <id>')
         .description('Delete store view')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store view delete 1
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();
@@ -134,6 +164,10 @@ export function registerStoresCommands(program) {
 
     views.command('edit <id>')
         .description('Edit store view')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store view edit 1
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();
@@ -157,6 +191,10 @@ export function registerStoresCommands(program) {
 
     configs.command('list')
         .description('List store configurations')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run store config list
+`)
         .action(async () => {
             try {
                 const client = await createClient();

package/lib/commands/tax.js

@@ -12,6 +12,11 @@ export function registerTaxCommands(program) {
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run tax class list
+  $ mage-remote-run tax class list --page 1 --size 50
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -46,6 +51,10 @@ export function registerTaxCommands(program) {
 
     taxClass.command('show <id>')
         .description('Show tax class details')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run tax class show 3
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();

package/lib/commands/webhooks.js

@@ -10,6 +10,11 @@ export function registerWebhooksCommands(program) {
         .option('-p, --page <number>', 'Page number', '1')
         .option('-s, --size <number>', 'Page size', '20')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run webhook list
+  $ mage-remote-run webhook list --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();

package/lib/commands/websites.js

@@ -9,6 +9,11 @@ export function registerWebsitesCommands(program) {
     websites.command('list')
         .description('List all websites')
         .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run website list
+  $ mage-remote-run website list --format json
+`)
         .action(async (options) => {
             try {
                 const client = await createClient();
@@ -34,6 +39,10 @@ export function registerWebsitesCommands(program) {
 
     websites.command('search <query>')
         .description('Search websites by code or name (local filter)')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run website search "Main"
+`)
         .action(async (query) => {
             try {
                 const client = await createClient();
@@ -48,6 +57,10 @@ export function registerWebsitesCommands(program) {
 
     websites.command('delete <id>')
         .description('Delete a website by ID')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run website delete 1
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();
@@ -66,6 +79,10 @@ export function registerWebsitesCommands(program) {
 
     websites.command('edit <id>')
         .description('Edit a website')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run website edit 1
+`)
         .action(async (id) => {
             try {
                 const client = await createClient();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mage-remote-run",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "The remote swiss army knife for Magento Open Source, Mage-OS, Adobe Commerce",
   "main": "index.js",
   "scripts": {