@automattic/vip 4.1.5 → 4.1.8

package/dist/bin/vip-wp.js

@@ -1,29 +1,63 @@
 #!/usr/bin/env node
 "use strict";
-
-var _core = require("@apollo/client/core");
-var _chalk = _interopRequireDefault(require("chalk"));
-var _debug = _interopRequireDefault(require("debug"));
-var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-var _readline = _interopRequireDefault(require("readline"));
-var _socket = _interopRequireDefault(require("socket.io-client"));
-var _socket2 = _interopRequireDefault(require("socket.io-stream"));
-var _stream = require("stream");
-var _wpSsh = require("../commands/wp-ssh");
-var _api = _interopRequireWildcard(require("../lib/api"));
-var _app = require("../lib/app");
-var _command = _interopRequireWildcard(require("../lib/cli/command"));
-var exit = _interopRequireWildcard(require("../lib/cli/exit"));
-var _format = require("../lib/cli/format");
-var _prompt = require("../lib/cli/prompt");
-var _proxyAgent = require("../lib/http/proxy-agent");
-var _token = _interopRequireDefault(require("../lib/token"));
-var _tracker = require("../lib/tracker");
-var _helpers = require("../lib/wp/helpers");
-var _readline2 = require("../lib/wp/readline");
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const debug = (0, _debug.default)('@automattic/vip:wp');
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@apollo/client/core");
+const chalk_1 = __importDefault(require("chalk"));
+const debug_1 = __importDefault(require("debug"));
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+const readline_1 = __importDefault(require("readline"));
+const socket_io_client_1 = __importDefault(require("socket.io-client"));
+const socket_io_stream_1 = __importDefault(require("socket.io-stream"));
+const stream_1 = require("stream");
+const wp_ssh_1 = require("../commands/wp-ssh");
+const api_1 = __importStar(require("../lib/api"));
+const app_1 = require("../lib/app");
+const command_1 = __importStar(require("../lib/cli/command"));
+const exit = __importStar(require("../lib/cli/exit"));
+const format_1 = require("../lib/cli/format");
+const prompt_1 = require("../lib/cli/prompt");
+const proxy_agent_1 = require("../lib/http/proxy-agent");
+const token_1 = __importDefault(require("../lib/token"));
+const tracker_1 = require("../lib/tracker");
+const helpers_1 = require("../lib/wp/helpers");
+const readline_2 = require("../lib/wp/readline");
+const debug = (0, debug_1.default)('@automattic/vip:wp');
 const appQuery = `id, name, typeId,
 	organization {
 		id
@@ -46,76 +80,95 @@ let currentJob = null;
 let currentOffset = 0;
 let commandRunning = false;
 const isStdinTty = process.stdin.isTTY;
-const normalizeNewlineStream = new _stream.Transform({
-  transform(chunk, encoding, callback) {
-    callback(null, chunk.toString().replace(/\r/g, '\n'));
-  }
+const normalizeNewlineStream = new stream_1.Transform({
+    transform(chunk, encoding, callback) {
+        callback(null, chunk.toString().replace(/\r/g, '\n'));
+    },
 });
-const pipeStreamsToProcess = ({
-  stdin,
-  stdout: outStream
-}) => {
-  if (isStdinTty) {
-    process.stdin.pipe(normalizeNewlineStream).pipe(stdin);
-  } else {
-    process.stdin.pipe(stdin);
-  }
-  outStream.pipe(process.stdout);
+const pipeStreamsToProcess = ({ stdin, stdout: outStream }) => {
+    if (isStdinTty) {
+        process.stdin.pipe(normalizeNewlineStream).pipe(stdin);
+    }
+    else {
+        process.stdin.pipe(stdin);
+    }
+    outStream.pipe(process.stdout);
 };
-const unpipeStreamsFromProcess = ({
-  stdin,
-  stdout: outStream
-}) => {
-  if (isStdinTty) {
-    process.stdin.unpipe(normalizeNewlineStream);
-    normalizeNewlineStream.unpipe(stdin);
-  } else {
-    process.stdin.unpipe(stdin);
-  }
-  outStream.unpipe(process.stdout);
+const unpipeStreamsFromProcess = ({ stdin, stdout: outStream }) => {
+    if (isStdinTty) {
+        process.stdin.unpipe(normalizeNewlineStream);
+        normalizeNewlineStream.unpipe(stdin);
+    }
+    else {
+        process.stdin.unpipe(stdin);
+    }
+    outStream.unpipe(process.stdout);
 };
-const bindStreamEvents = ({
-  subShellRl,
-  commonTrackingParams,
-  isSubShell,
-  stdoutStream
-}) => {
-  const criticalErrors = ['ECONNRESET', 'ETIMEDOUT', 'EHOSTUNREACH', 'ENOSPC', 'EACCES', 'EMFILE', 'ENOMEM'];
-  stdoutStream.on('error', err => {
-    commandRunning = false;
-    if (criticalErrors.includes(err.code)) {
-      console.error(`Error: ${err.message}`);
-    } else {
-      // TODO handle this better
-      debug('Error: ' + err.message);
+const finishCommand = ({ subShellRl, commonTrackingParams, isSubShell, exitCode = 0, job = currentJob, }) => {
+    if (job !== currentJob || job.finished) {
+        return;
     }
-  });
-  stdoutStream.on('end', async () => {
+    currentJob.finished = true;
+    clearTimeout(currentJob.exitTimer);
+    clearTimeout(currentJob.retryTimer);
     subShellRl.clearLine();
     commandRunning = false;
-    await (0, _tracker.trackEvent)('wpcli_command_end', commonTrackingParams);
-
-    // Tell socket.io to stop trying to connect
+    const tracking = (0, tracker_1.trackEvent)('wpcli_command_end', commonTrackingParams).catch(() => { });
     currentJob.socket.close();
-    unpipeStreamsFromProcess({
-      stdin: currentJob.stdinStream,
-      stdout: currentJob.stdoutStream
-    });
-
-    // Reset offset
+    unpipeStreamsFromProcess({ stdin: currentJob.stdinStream, stdout: currentJob.stdoutStream });
     currentOffset = 0;
     if (!isSubShell) {
-      subShellRl.close();
-      process.exit();
+        subShellRl.close();
+        void tracking.catch(() => { }).finally(() => process.exit(exitCode));
+        return;
     }
-    (0, _readline2.safeResume)(subShellRl);
-    (0, _readline2.safePrompt)(subShellRl);
-  });
+    if (exitCode) {
+        console.log(chalk_1.default.red(`Error: WP-CLI command failed with exit code ${exitCode}`));
+    }
+    (0, readline_2.safeResume)(subShellRl);
+    (0, readline_2.safePrompt)(subShellRl);
+};
+const bindStreamEvents = ({ subShellRl, commonTrackingParams, isSubShell, stdoutStream }) => {
+    const job = currentJob;
+    const isCurrentStream = () => job === currentJob && !job.finished && stdoutStream === job.stdoutStream;
+    const criticalErrors = [
+        'ECONNRESET',
+        'ETIMEDOUT',
+        'EHOSTUNREACH',
+        'ENOSPC',
+        'EACCES',
+        'EMFILE',
+        'ENOMEM',
+    ];
+    stdoutStream.on('error', err => {
+        if (!isCurrentStream()) {
+            return;
+        }
+        commandRunning = false;
+        if (criticalErrors.includes(err.code)) {
+            console.error(`Error: ${err.message}`);
+        }
+        else {
+            // TODO handle this better
+            debug('Error: ' + err.message);
+        }
+    });
+    stdoutStream.on('end', () => {
+        // Allow the server's exit event to deliver its status after stdout EOF.
+        if (isCurrentStream()) {
+            clearTimeout(job.exitTimer);
+            job.exitTimer = setTimeout(() => {
+                if (isCurrentStream()) {
+                    finishCommand({ subShellRl, commonTrackingParams, isSubShell, job });
+                }
+            }, 2000);
+        }
+    });
 };
 const getTokenForCommand = async (appId, envId, command) => {
-  const api = (0, _api.default)();
-  return api.mutate({
-    mutation: (0, _graphqlTag.default)`
+    const api = (0, api_1.default)();
+    return api.mutate({
+        mutation: (0, graphql_tag_1.default) `
 			mutation TriggerWPCLICommandMutation($input: AppEnvironmentTriggerWPCLICommandInput) {
 				triggerWPCLICommandOnAppEnvironment(input: $input) {
 					inputToken
@@ -125,16 +178,15 @@ const getTokenForCommand = async (appId, envId, command) => {
 				}
 			}
 		`,
-    variables: {
-      input: {
-        id: appId,
-        environmentId: envId,
-        command
-      }
-    }
-  });
+        variables: {
+            input: {
+                id: appId,
+                environmentId: envId,
+                command,
+            },
+        },
+    });
 };
-
 /**
  * Returns the error so it can be caught by the `socket.on('error')`.
  *
@@ -142,391 +194,385 @@ const getTokenForCommand = async (appId, envId, command) => {
  * @returns {Error}
  */
 const onSocketError = err => err;
-const launchCommandAndGetStreams = async ({
-  socket,
-  guid,
-  inputToken,
-  offset = 0
-}) => {
-  const stdoutStream = _socket2.default.createStream();
-  const stdinStream = _socket2.default.createStream();
-  stdoutStream.on('data', data => {
-    currentOffset = data.length + currentOffset;
-  });
-
-  // TODO handle all arguments
-  // TODO handle disconnect - does IOStream correctly buffer stdin?
-  // TODO stderr - currently server doesn't support it, so errors don't terminate process
-
-  const data = {
-    guid,
-    inputToken,
-    columns: process.stdout.columns || NON_TTY_COLUMNS,
-    rows: process.stdout.rows || NON_TTY_ROWS,
-    offset
-  };
-  (0, _socket2.default)(socket).emit('cmd', data, stdinStream, stdoutStream);
-  socket.on('unauthorized', err => {
-    console.log('There was an error with the authentication:', err.message);
-  });
-  socket.on('cancel', message => {
-    socket.close();
-    exit.withError(`Cancel received from server: ${message}`);
-  });
-  (0, _socket2.default)(socket).off('error', onSocketError).on('error', onSocketError);
-  socket.on('error', err => {
-    if (err === 'Rate limit exceeded') {
-      console.log(_chalk.default.red('\nError:'), 'Rate limit exceeded: Please wait a moment and try again.');
-      return;
+const launchCommandAndGetStreams = ({ socket, guid, inputToken, offset = 0 }) => {
+    const stdoutStream = socket_io_stream_1.default.createStream();
+    const stdinStream = socket_io_stream_1.default.createStream();
+    stdoutStream.on('data', data => {
+        if (currentJob?.stdoutStream === stdoutStream && !currentJob.finished) {
+            currentOffset += data.length;
+        }
+    });
+    // TODO handle all arguments
+    // TODO handle disconnect - does IOStream correctly buffer stdin?
+    // TODO stderr - currently server doesn't support it, so errors don't terminate process
+    const data = {
+        guid,
+        inputToken,
+        columns: process.stdout.columns || NON_TTY_COLUMNS,
+        rows: process.stdout.rows || NON_TTY_ROWS,
+        offset,
+    };
+    (0, socket_io_stream_1.default)(socket).emit('cmd', data, stdinStream, stdoutStream);
+    const onUnauthorized = err => {
+        if (currentJob?.socket !== socket || currentJob.finished) {
+            return;
+        }
+        console.log('There was an error with the authentication:', err.message);
+    };
+    const onCancel = message => {
+        if (currentJob?.socket !== socket || currentJob.finished) {
+            return;
+        }
+        socket.close();
+        exit.withError(`Cancel received from server: ${message}`);
+    };
+    (0, socket_io_stream_1.default)(socket).off('error', onSocketError).on('error', onSocketError);
+    const onError = err => {
+        if (currentJob?.socket !== socket || currentJob.finished) {
+            return;
+        }
+        if (err === 'Rate limit exceeded') {
+            console.log(chalk_1.default.red('\nError:'), 'Rate limit exceeded: Please wait a moment and try again.');
+            return;
+        }
+        console.log(err);
+    };
+    if (currentJob?.socket === socket) {
+        for (const [event, handler] of Object.entries(currentJob.socketHandlers)) {
+            socket.off(event, handler);
+        }
     }
-    console.log(err);
-  });
-  return {
-    stdinStream,
-    stdoutStream,
-    socket
-  };
+    const socketHandlers = { unauthorized: onUnauthorized, cancel: onCancel, error: onError };
+    for (const [event, handler] of Object.entries(socketHandlers)) {
+        socket.on(event, handler);
+    }
+    return { stdinStream, stdoutStream, socket, socketHandlers };
 };
-const bindReconnectEvents = ({
-  cliCommand,
-  inputToken,
-  subShellRl,
-  commonTrackingParams,
-  isSubShell
-}) => {
-  currentJob.socket.io.removeAllListeners('reconnect');
-  currentJob.socket.io.removeAllListeners('reconnect_attempt');
-  currentJob.socket.removeAllListeners('retry');
-  currentJob.socket.removeAllListeners('connect_error');
-  currentJob.socket.io.on('reconnect', async () => {
-    debug('socket.io: reconnect');
-
-    // Close old streams
-    unpipeStreamsFromProcess({
-      stdin: currentJob.stdinStream,
-      stdout: currentJob.stdoutStream
-    });
-    (0, _tracker.trackEvent)('wpcli_command_reconnect', commonTrackingParams).catch(() => {});
-    currentJob = await launchCommandAndGetStreams({
-      socket: currentJob.socket,
-      guid: cliCommand.guid,
-      inputToken,
-      offset: currentOffset
-    });
-
-    // Rebind new streams
-    pipeStreamsToProcess({
-      stdin: currentJob.stdinStream,
-      stdout: currentJob.stdoutStream
+const bindReconnectEvents = ({ cliCommand, inputToken, subShellRl, commonTrackingParams, isSubShell, }) => {
+    const job = currentJob;
+    const isCurrentJob = () => job === currentJob && !job.finished;
+    currentJob.socket.io.removeAllListeners('reconnect');
+    currentJob.socket.io.removeAllListeners('reconnect_attempt');
+    currentJob.socket.removeAllListeners('retry');
+    currentJob.socket.removeAllListeners('connect_error');
+    currentJob.socket.removeAllListeners('exit');
+    currentJob.socket.io.on('reconnect', () => {
+        if (!isCurrentJob()) {
+            return;
+        }
+        debug('socket.io: reconnect');
+        clearTimeout(job.exitTimer);
+        clearTimeout(job.retryTimer);
+        // Close old streams
+        unpipeStreamsFromProcess({ stdin: currentJob.stdinStream, stdout: currentJob.stdoutStream });
+        (0, tracker_1.trackEvent)('wpcli_command_reconnect', commonTrackingParams).catch(() => { });
+        job.finished = true;
+        currentJob = launchCommandAndGetStreams({
+            socket: currentJob.socket,
+            guid: cliCommand.guid,
+            inputToken,
+            offset: currentOffset,
+        });
+        // Rebind new streams
+        pipeStreamsToProcess({ stdin: currentJob.stdinStream, stdout: currentJob.stdoutStream });
+        bindStreamEvents({
+            subShellRl,
+            isSubShell,
+            commonTrackingParams,
+            stdoutStream: currentJob.stdoutStream,
+        });
+        bindReconnectEvents({ cliCommand, inputToken, subShellRl, commonTrackingParams, isSubShell });
+        // Resume readline interface
+        (0, readline_2.safeResume)(subShellRl);
     });
-    bindStreamEvents({
-      subShellRl,
-      isSubShell,
-      commonTrackingParams,
-      stdoutStream: currentJob.stdoutStream
+    currentJob.socket.on('retry', () => {
+        if (!isCurrentJob()) {
+            return;
+        }
+        debug('socket: retry');
+        clearTimeout(job.retryTimer);
+        job.retryTimer = setTimeout(() => {
+            if (isCurrentJob()) {
+                job.socket.io.engine.close();
+            }
+        }, 5000);
     });
-    bindReconnectEvents({
-      cliCommand,
-      inputToken,
-      subShellRl,
-      commonTrackingParams,
-      isSubShell
+    currentJob.socket.on('connect_error', () => {
+        if (!isCurrentJob()) {
+            return;
+        }
+        debug('socket: connect_error; forcing the preference for websocket');
+        // Force the preference for WebSocket in case we see an error during connection
+        // https://socket.io/docs/v3/client-initialization/#low-level-engine-options
+        currentJob.socket.io.opts.transports = ['websocket', 'polling'];
     });
-
-    // Resume readline interface
-    (0, _readline2.safeResume)(subShellRl);
-  });
-  currentJob.socket.on('retry', async () => {
-    debug('socket: retry');
-    setTimeout(() => {
-      currentJob.socket.io.engine.close();
-    }, 5000);
-  });
-  currentJob.socket.on('connect_error', () => {
-    debug('socket: connect_error; forcing the preference for websocket');
-
-    // Force the preference for WebSocket in case we see an error during connection
-    // https://socket.io/docs/v3/client-initialization/#low-level-engine-options
-    currentJob.socket.io.opts.transports = ['websocket', 'polling'];
-  });
-  currentJob.socket.on('exit', async ({
-    exitCode,
-    message
-  }) => {
-    debug('socket: exit. Code: %d. Message: %s', exitCode, message);
-    if (message) {
-      console.log(message);
-    }
-    currentJob.stdinStream.destroy();
-    currentJob.stdoutStream.destroy();
-    currentJob.socket.close();
-    process.exit(exitCode);
-  });
-  currentJob.socket.io.on('reconnect_attempt', attempt => {
-    debug('There was an error connecting to the server. Retrying...');
-    if (attempt > 1) {
-      return;
-    }
-
-    // create a new input stream so that we can still catch things like SIGINT while reconnecting
-    if (currentJob.stdinStream) {
-      unpipeStreamsFromProcess({
-        stdin: currentJob.stdinStream,
-        stdout: currentJob.stdoutStream
-      });
-    }
-    currentJob.stdinStream = _socket2.default.createStream();
-    currentJob.stdoutStream = _socket2.default.createStream();
-    pipeStreamsToProcess({
-      stdin: currentJob.stdinStream,
-      stdout: currentJob.stdoutStream
+    currentJob.socket.on('exit', ({ exitCode, message }) => {
+        if (!isCurrentJob()) {
+            return;
+        }
+        debug('socket: exit. Code: %d. Message: %s', exitCode, message);
+        if (message) {
+            console.log(message);
+        }
+        currentJob.stdinStream.destroy();
+        currentJob.stdoutStream.destroy();
+        finishCommand({ subShellRl, commonTrackingParams, isSubShell, exitCode });
     });
-    bindStreamEvents({
-      subShellRl,
-      isSubShell,
-      commonTrackingParams,
-      stdoutStream: currentJob.stdoutStream
+    currentJob.socket.io.on('reconnect_attempt', attempt => {
+        if (!isCurrentJob()) {
+            return;
+        }
+        debug('There was an error connecting to the server. Retrying...');
+        if (attempt > 1) {
+            return;
+        }
+        clearTimeout(job.exitTimer);
+        clearTimeout(job.retryTimer);
+        // create a new input stream so that we can still catch things like SIGINT while reconnecting
+        if (currentJob.stdinStream) {
+            unpipeStreamsFromProcess({
+                stdin: currentJob.stdinStream,
+                stdout: currentJob.stdoutStream,
+            });
+        }
+        currentJob.stdinStream = socket_io_stream_1.default.createStream();
+        currentJob.stdoutStream = socket_io_stream_1.default.createStream();
+        pipeStreamsToProcess({ stdin: currentJob.stdinStream, stdout: currentJob.stdoutStream });
+        bindStreamEvents({
+            subShellRl,
+            isSubShell,
+            commonTrackingParams,
+            stdoutStream: currentJob.stdoutStream,
+        });
     });
-  });
 };
-
 // Command examples
-const examples = [{
-  usage: `vip @example-app.develop -- wp site list`,
-  description: 'Use a WP-CLI command to retrieve the list of network sites on the develop environment of the "example-app" WordPress multisite application.'
-}, {
-  usage: `vip @example-app.production --yes -- wp user list`,
-  description: 'Use a WP-CLI command to retrieve the list of Super Admins on the production environment and automatically answer "yes" to the confirmation prompt.'
-}, {
-  usage: `vip @example-app.develop -- wp post list --posts_per_page=100 --url=dev.example.com`,
-  description: 'Use a WP-CLI command to retrieve the list of posts for the network site dev.example.com.'
-}, {
-  usage: `vip @example-app.develop -- wp\n` + `    - example-app.develop:~$ wp option get home\n` + `    - https://dev.example.com`,
-  description: 'Use the VIP-CLI to launch an interactive WP-CLI shell console and run WP-CLI commands on the develop environment.'
-}];
-(0, _command.default)({
-  wildcardCommand: true,
-  appContext: true,
-  envContext: true,
-  appQuery
-}).option('yes', 'Answer yes to the confirmation prompt (only on production environments).').examples(examples).argv(process.argv, async (args, opts) => {
-  const isSubShell = 0 === args.length;
-
-  // Have to re-quote anything that needs it before we pass it on
-  const quotedArgs = (0, _format.requoteArgs)(args);
-  const cmd = quotedArgs.join(' ');
-
-  // Store only the first 2 parts of command to avoid recording secrets. Can be tweaked
-  const commandForAnalytics = quotedArgs.slice(0, 2).join(' ');
-  const {
-    id: appId,
-    name: appName,
-    typeId: appTypeId,
-    organization: {
-      id: orgId
-    }
-  } = opts.app;
-  const {
-    id: envId,
-    type: envName
-  } = opts.env;
-  if ((0, _app.isAppNodejs)(appTypeId)) {
-    exit.withError('WP-CLI commands are not supported on Node.js environments.');
-  }
-  const commonTrackingParams = {
-    command: commandForAnalytics,
-    app_id: appId,
-    env_id: envId,
-    org_id: orgId,
-    method: isSubShell ? 'subshell' : 'shell'
-  };
-  (0, _tracker.trackEvent)('wpcli_command_execute', commonTrackingParams).catch(() => {});
-  if (isSubShell) {
-    // Reset the cursor (can get messed up with enquirer)
-    process.stdout.write('\u001b[?25h');
-    console.log(`Welcome to the WP-CLI shell for the ${(0, _format.formatEnvironment)(envName)} environment of ${_chalk.default.green(appName)} (${opts.env.primaryDomain.name})!`);
-  } else if (envName === 'production') {
-    const yes = opts.yes || (await (0, _prompt.confirm)([{
-      key: 'command',
-      value: `wp ${cmd}`
-    }], `Are you sure you want to run this command on ${(0, _format.formatEnvironment)(envName)} for site ${appName}?`));
-    if (!yes) {
-      (0, _tracker.trackEvent)('wpcli_confirm_cancel', commonTrackingParams).catch(() => {});
-      console.log('Command cancelled');
-      process.exit();
-    }
-  }
-
-  // We'll handle our own errors, thank you
-  (0, _api.disableGlobalGraphQLErrorHandling)();
-  const promptIdentifier = `${appName}.${(0, _command.getEnvIdentifier)(opts.env)}`;
-  let countSIGINT = 0;
-  if (opts.env.wpcliStrategy === 'ssh') {
-    const wpCommandRunner = new _wpSsh.WPCliCommandOverSSH(opts.app, opts.env);
-    await wpCommandRunner.run(cmd, {
-      command: commandForAnalytics
-    });
-    return;
-  }
-  const mutableStdout = new _stream.Writable({
-    write(chunk, encoding, callback) {
-      if (!this.muted) {
-        process.stdout.write(chunk, encoding);
-      }
-      callback();
+const examples = [
+    {
+        usage: `vip @example-app.develop -- wp site list`,
+        description: 'Use a WP-CLI command to retrieve the list of network sites on the develop environment of the "example-app" WordPress multisite application.',
+    },
+    {
+        usage: `vip @example-app.production --yes -- wp user list`,
+        description: 'Use a WP-CLI command to retrieve the list of Super Admins on the production environment and automatically answer "yes" to the confirmation prompt.',
+    },
+    {
+        usage: `vip @example-app.develop -- wp post list --posts_per_page=100 --url=dev.example.com`,
+        description: 'Use a WP-CLI command to retrieve the list of posts for the network site dev.example.com.',
+    },
+    {
+        usage: `vip @example-app.develop -- wp\n` +
+            `    - example-app.develop:~$ wp option get home\n` +
+            `    - https://dev.example.com`,
+        description: 'Use the VIP-CLI to launch an interactive WP-CLI shell console and run WP-CLI commands on the develop environment.',
+    },
+];
+(0, command_1.default)({
+    wildcardCommand: true,
+    appContext: true,
+    envContext: true,
+    appQuery,
+})
+    .option('yes', 'Answer yes to the confirmation prompt (only on production environments).')
+    .examples(examples)
+    .argv(process.argv, async (args, opts) => {
+    const isSubShell = 0 === args.length;
+    // Have to re-quote anything that needs it before we pass it on
+    const quotedArgs = (0, format_1.requoteArgs)(args);
+    const cmd = quotedArgs.join(' ');
+    // Store only the first 2 parts of command to avoid recording secrets. Can be tweaked
+    const commandForAnalytics = quotedArgs.slice(0, 2).join(' ');
+    const { id: appId, name: appName, typeId: appTypeId, organization: { id: orgId }, } = opts.app;
+    const { id: envId, type: envName } = opts.env;
+    if ((0, app_1.isAppNodejs)(appTypeId)) {
+        exit.withError('WP-CLI commands are not supported on Node.js environments.');
     }
-  });
-  mutableStdout.muted = false;
-  const subShellSettings = {
-    input: process.stdin,
-    output: mutableStdout,
-    terminal: true,
-    prompt: '',
-    historySize: 0,
-    crlfDelay: Infinity
-  };
-  if (isSubShell) {
-    subShellSettings.prompt = _chalk.default.bold.yellowBright(`${promptIdentifier}:`) + _chalk.default.blue('~') + '$ ';
-    subShellSettings.historySize = 200;
-  }
-  const commandState = (0, _helpers.initState)();
-  let seenWP = false;
-  const subShellRl = _readline.default.createInterface(subShellSettings);
-  (0, _readline2.trackReadline)(subShellRl);
-  subShellRl.on('line', async line => {
-    if (commandRunning) {
-      return;
-    }
-
-    // Handle plain return / newline
-    if (!line) {
-      (0, _readline2.safePrompt)(subShellRl);
-      return;
-    }
-
-    // Check for exit, like SSH (handles both `exit` and `exit;`)
-    if (!seenWP && line.startsWith('exit')) {
-      subShellRl.close();
-      process.exit();
-    }
-    const userCmdCancelled = line === cancelCommandChar;
-    if (userCmdCancelled) {
-      seenWP = false;
-      (0, _helpers.resetState)(commandState);
-      (0, _readline2.safePrompt)(subShellRl);
-      return;
+    const commonTrackingParams = {
+        command: commandForAnalytics,
+        app_id: appId,
+        env_id: envId,
+        org_id: orgId,
+        method: isSubShell ? 'subshell' : 'shell',
+    };
+    (0, tracker_1.trackEvent)('wpcli_command_execute', commonTrackingParams).catch(() => { });
+    if (isSubShell) {
+        // Reset the cursor (can get messed up with enquirer)
+        process.stdout.write('\u001b[?25h');
+        console.log(`Welcome to the WP-CLI shell for the ${(0, format_1.formatEnvironment)(envName)} environment of ${chalk_1.default.green(appName)} (${opts.env.primaryDomain.name})!`);
     }
-    if (!seenWP && line.trimStart().startsWith('wp ')) {
-      seenWP = true;
-      (0, _helpers.resetState)(commandState);
+    else if (envName === 'production') {
+        const yes = opts.yes ||
+            (await (0, prompt_1.confirm)([
+                {
+                    key: 'command',
+                    value: `wp ${cmd}`,
+                },
+            ], `Are you sure you want to run this command on ${(0, format_1.formatEnvironment)(envName)} for site ${appName}?`));
+        if (!yes) {
+            (0, tracker_1.trackEvent)('wpcli_confirm_cancel', commonTrackingParams).catch(() => { });
+            console.log('Command cancelled');
+            process.exit();
+        }
     }
-    if (seenWP) {
-      (0, _helpers.stateMachine)(commandState, line);
-      if (!commandState.done) {
+    // We'll handle our own errors, thank you
+    (0, api_1.disableGlobalGraphQLErrorHandling)();
+    const promptIdentifier = `${appName}.${(0, command_1.getEnvIdentifier)(opts.env)}`;
+    let countSIGINT = 0;
+    if (opts.env.wpcliStrategy === 'ssh') {
+        const wpCommandRunner = new wp_ssh_1.WPCliCommandOverSSH(opts.app, opts.env);
+        await wpCommandRunner.run(cmd, { command: commandForAnalytics });
         return;
-      }
-    } else {
-      (0, _helpers.resetState)(commandState);
-      console.log(_chalk.default.red('Error:'), 'invalid command, please pass a valid WP-CLI command.');
-      (0, _readline2.safePrompt)(subShellRl);
-      return;
     }
-    (0, _readline2.safePause)(subShellRl);
-    let result;
-    const wpCliCmd = commandState.command.replace(/^wp\s+/, '');
-    seenWP = false;
-    (0, _helpers.resetState)(commandState);
-    try {
-      result = await getTokenForCommand(appId, envId, wpCliCmd);
-    } catch (error) {
-      // If this was a GraphQL error, print that to the message to the line
-      if (_core.CombinedGraphQLErrors.is(error)) {
-        for (const err of error.errors) {
-          console.log(_chalk.default.red('Error:'), err.message);
-        }
-      } else {
-        // Else, other type of error, just dump it
-        console.log(error);
-      }
-      if (!isSubShell) {
-        subShellRl.close();
-        process.exit(1);
-      }
-      (0, _readline2.safePrompt)(subShellRl);
-      return;
+    const mutableStdout = new stream_1.Writable({
+        write(chunk, encoding, callback) {
+            if (!this.muted) {
+                process.stdout.write(chunk, encoding);
+            }
+            callback();
+        },
+    });
+    mutableStdout.muted = false;
+    const subShellSettings = {
+        input: process.stdin,
+        output: mutableStdout,
+        terminal: true,
+        prompt: '',
+        historySize: 0,
+        crlfDelay: Infinity,
+    };
+    if (isSubShell) {
+        subShellSettings.prompt =
+            chalk_1.default.bold.yellowBright(`${promptIdentifier}:`) + chalk_1.default.blue('~') + '$ ';
+        subShellSettings.historySize = 200;
     }
-    const {
-      data: {
-        triggerWPCLICommandOnAppEnvironment: {
-          command: cliCommand,
-          inputToken
+    const commandState = (0, helpers_1.initState)();
+    let seenWP = false;
+    const subShellRl = readline_1.default.createInterface(subShellSettings);
+    (0, readline_2.trackReadline)(subShellRl);
+    subShellRl.on('line', async (line) => {
+        if (commandRunning) {
+            return;
         }
-      }
-    } = result;
-    const token = await _token.default.get();
-    const extraHeaders = {
-      Authorization: `Bearer ${token.raw}`
-    };
-    const socket = (0, _socket.default)(`${_api.API_HOST}/wp-cli`, {
-      transportOptions: {
-        polling: {
-          extraHeaders
-        },
-        websocket: {
-          extraHeaders
+        // Handle plain return / newline
+        if (!line && !seenWP) {
+            (0, readline_2.safePrompt)(subShellRl);
+            return;
         }
-      },
-      agent: (0, _proxyAgent.createProxyAgent)(_api.API_HOST)
-    });
-    currentJob = await launchCommandAndGetStreams({
-      socket,
-      guid: cliCommand.guid,
-      inputToken
-    });
-    pipeStreamsToProcess({
-      stdin: currentJob.stdinStream,
-      stdout: currentJob.stdoutStream
-    });
-    commandRunning = true;
-    bindStreamEvents({
-      subShellRl,
-      commonTrackingParams,
-      isSubShell,
-      stdoutStream: currentJob.stdoutStream
+        // Check for exit, like SSH (handles both `exit` and `exit;`)
+        if (!seenWP && line.startsWith('exit')) {
+            subShellRl.close();
+            process.exit();
+        }
+        const userCmdCancelled = line === cancelCommandChar;
+        if (userCmdCancelled) {
+            seenWP = false;
+            (0, helpers_1.resetState)(commandState);
+            (0, readline_2.safePrompt)(subShellRl);
+            return;
+        }
+        if (!seenWP && line.trimStart().startsWith('wp ')) {
+            seenWP = true;
+            (0, helpers_1.resetState)(commandState);
+        }
+        if (seenWP) {
+            (0, helpers_1.stateMachine)(commandState, line);
+            if (!commandState.done) {
+                return;
+            }
+        }
+        else {
+            (0, helpers_1.resetState)(commandState);
+            console.log(chalk_1.default.red('Error:'), 'invalid command, please pass a valid WP-CLI command.');
+            (0, readline_2.safePrompt)(subShellRl);
+            return;
+        }
+        (0, readline_2.safePause)(subShellRl);
+        countSIGINT = 0;
+        let result;
+        const wpCliCmd = commandState.command.trimStart().replace(/^wp\s+/, '');
+        seenWP = false;
+        (0, helpers_1.resetState)(commandState);
+        try {
+            result = await getTokenForCommand(appId, envId, wpCliCmd);
+        }
+        catch (error) {
+            // If this was a GraphQL error, print that to the message to the line
+            if (core_1.CombinedGraphQLErrors.is(error)) {
+                for (const err of error.errors) {
+                    console.log(chalk_1.default.red('Error:'), err.message);
+                }
+            }
+            else {
+                // Else, other type of error, just dump it
+                console.log(error);
+            }
+            if (!isSubShell) {
+                subShellRl.close();
+                process.exit(1);
+            }
+            (0, readline_2.safePrompt)(subShellRl);
+            return;
+        }
+        const { data: { triggerWPCLICommandOnAppEnvironment: { command: cliCommand, inputToken }, }, } = result;
+        const token = await token_1.default.get();
+        const extraHeaders = {
+            Authorization: `Bearer ${token.raw}`,
+        };
+        const socket = (0, socket_io_client_1.default)(`${api_1.API_HOST}/wp-cli`, {
+            transportOptions: {
+                polling: {
+                    extraHeaders,
+                },
+                websocket: {
+                    extraHeaders,
+                },
+            },
+            agent: (0, proxy_agent_1.createProxyAgent)(api_1.API_HOST),
+        });
+        currentJob = launchCommandAndGetStreams({
+            socket,
+            guid: cliCommand.guid,
+            inputToken,
+        });
+        pipeStreamsToProcess({ stdin: currentJob.stdinStream, stdout: currentJob.stdoutStream });
+        commandRunning = true;
+        bindStreamEvents({
+            subShellRl,
+            commonTrackingParams,
+            isSubShell,
+            stdoutStream: currentJob.stdoutStream,
+        });
+        bindReconnectEvents({
+            cliCommand,
+            inputToken,
+            subShellRl,
+            commonTrackingParams,
+            isSubShell,
+        });
     });
-    bindReconnectEvents({
-      cliCommand,
-      inputToken,
-      subShellRl,
-      commonTrackingParams,
-      isSubShell
+    subShellRl.on('SIGINT', async () => {
+        // if we have a 2nd SIGINT, exit immediately
+        if (countSIGINT >= 1) {
+            process.exit();
+        }
+        countSIGINT += 1;
+        // write out CTRL-C/SIGINT
+        process.stdin.write(cancelCommandChar);
+        if (currentJob?.stdoutStream) {
+            currentJob.stdoutStream.end();
+        }
+        await (0, tracker_1.trackEvent)('wpcli_cancel_command', commonTrackingParams);
+        console.log('Command cancelled by user');
+        // if no command running (.e.g. interactive shell) exit only after doing cleanup
+        if (commandRunning === false) {
+            process.exit();
+        }
     });
-  });
-  subShellRl.on('SIGINT', async () => {
-    // if we have a 2nd SIGINT, exit immediately
-    if (countSIGINT >= 1) {
-      process.exit();
-    }
-    countSIGINT += 1;
-
-    // write out CTRL-C/SIGINT
-    process.stdin.write(cancelCommandChar);
-    if (currentJob?.stdoutStream) {
-      currentJob.stdoutStream.end();
-    }
-    await (0, _tracker.trackEvent)('wpcli_cancel_command', commonTrackingParams);
-    console.log('Command cancelled by user');
-
-    // if no command running (.e.g. interactive shell) exit only after doing cleanup
-    if (commandRunning === false) {
-      process.exit();
+    if (!isSubShell) {
+        mutableStdout.muted = true;
+        (0, readline_2.safeWrite)(subShellRl, `wp ${cmd}\n`);
+        mutableStdout.muted = false;
+        return;
     }
-  });
-  if (!isSubShell) {
-    mutableStdout.muted = true;
-    (0, _readline2.safeWrite)(subShellRl, `wp ${cmd}\n`);
-    mutableStdout.muted = false;
-    return;
-  }
-  (0, _readline2.safePrompt)(subShellRl);
-});
+    (0, readline_2.safePrompt)(subShellRl);
+});