@scandipwa/magento-scripts 2.4.11 → 2.4.12-alpha.0

package/index.js

@@ -6,6 +6,7 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger')
 const semver = require('semver')
 const isInstalledGlobally = require('is-installed-globally')
 const isRunningRoot = require('./lib/util/is-running-root')
+const ensureAgentsMd = require('./lib/util/ensure-agents-md')
 
 if (isRunningRoot()) {
     logger.error('Root privileges detected!')
@@ -27,6 +28,8 @@ If you are experiencing problems with ${logger.style.misc(
     process.exit(1)
 }
 
+ensureAgentsMd()
+
 const commands = [
     require('./lib/commands/link'),
     require('./lib/commands/logs'),
@@ -123,6 +126,14 @@ const newVersionIsAPatch = (latestVersion, currentVersion) => {
     yargs.scriptName('magento-scripts')
     yargs.version(false)
 
+    yargs.option('silent', {
+        alias: 'q',
+        describe:
+            'Suppress all task progress output (Listr silent renderer). Enabled automatically when stdout is not a TTY.',
+        type: 'boolean',
+        default: false
+    })
+
     // Initialize program commands
     commands.forEach((command) => command(yargs))
 

package/lib/commands/cleanup.js

@@ -18,12 +18,16 @@ module.exports = (yargs) => {
             }),
         async (args) => {
             logger.warn('you should not use this command.')
+            const silent = /** @type {boolean} */ (args.silent)
             const tasks = new Listr(cleanup(), {
                 concurrent: false,
                 exitOnError: true,
                 ctx: {
-                    force: args.force
+                    force: args.force,
+                    silent
                 },
+                renderer:
+                    silent || !process.stdout.isTTY ? 'silent' : 'default',
                 rendererOptions: { collapse: false }
             })
 

package/lib/commands/cli.js

@@ -20,7 +20,8 @@ module.exports = (yargs) => {
         'Enter CLI (magento, php, composer).',
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {},
-        async () => {
+        async (args) => {
+            const silent = /** @type {boolean} */ (args.silent)
             const tasks = new Listr(
                 [
                     getMagentoVersionConfig(),
@@ -33,8 +34,11 @@ module.exports = (yargs) => {
                     concurrent: false,
                     exitOnError: true,
                     ctx: {
-                        throwMagentoVersionMissing: true
+                        throwMagentoVersionMissing: true,
+                        silent
                     },
+                    renderer:
+                        silent || !process.stdout.isTTY ? 'silent' : 'default',
                     rendererOptions: { collapse: false, clearOutput: true }
                 }
             )

package/lib/commands/import-db.js

@@ -27,12 +27,25 @@ module.exports = (yargs) => {
                 type: 'boolean',
                 default: false
             })
+            yargs.option('non-interactive', {
+                alias: 'y',
+                describe:
+                    'Skip all interactive prompts using sensible defaults',
+                type: 'boolean',
+                default: false
+            })
         },
         async (args) => {
             const tasks = new Listr(importDump(), {
                 exitOnError: true,
                 ctx: args,
                 concurrent: false,
+                renderer:
+                    /** @type {boolean} */ (args.silent) ||
+                    /** @type {boolean} */ (args.nonInteractive) ||
+                    !process.stdout.isTTY
+                        ? 'silent'
+                        : 'default',
                 rendererOptions: {
                     showErrorMessage: false,
                     showTimer: true

package/lib/commands/link.js

@@ -17,12 +17,18 @@ module.exports = (yargs) => {
                 default: false
             }),
         async (args) => {
-            const tasks = new Listr(linkTask(args.themepath), {
-                concurrent: false,
-                exitOnError: true,
-                ctx: { throwMagentoVersionMissing: true },
-                rendererOptions: { collapse: false }
-            })
+            const silent = /** @type {boolean} */ (args.silent)
+            const tasks = new Listr(
+                linkTask(/** @type {string} */ (args.themepath)),
+                {
+                    concurrent: false,
+                    exitOnError: true,
+                    ctx: { throwMagentoVersionMissing: true, silent },
+                    renderer:
+                        silent || !process.stdout.isTTY ? 'silent' : 'default',
+                    rendererOptions: { collapse: false }
+                }
+            )
 
             try {
                 await tasks.run()

package/lib/commands/logs.js

@@ -70,6 +70,7 @@ npm run logs re (will match redis)`)
             })
         },
         async (argv) => {
+            const silent = /** @type {boolean} */ (argv.silent)
             const tasks = new Listr(
                 [
                     checkRequirements(),
@@ -82,7 +83,12 @@ npm run logs re (will match redis)`)
                 {
                     concurrent: false,
                     exitOnError: true,
-                    ctx: { throwMagentoVersionMissing: true },
+                    ctx: {
+                        throwMagentoVersionMissing: true,
+                        silent
+                    },
+                    renderer:
+                        silent || !process.stdout.isTTY ? 'silent' : 'default',
                     rendererOptions: { collapse: false, clearOutput: true }
                 }
             )

package/lib/commands/start.js

@@ -64,9 +64,9 @@ module.exports = (yargs) => {
                     type: 'number',
                     nargs: 1
                 })
-                .option('no-open', {
+                .option('open', {
                     alias: 'n',
-                    describe: 'Do not open browser after command finished',
+                    describe: 'Open browser after command finished',
                     type: 'boolean',
                     default: false
                 })
@@ -109,6 +109,11 @@ module.exports = (yargs) => {
                 exitOnError: true,
                 ctx: args,
                 concurrent: false,
+                renderer:
+                    /** @type {boolean} */ (args.silent) ||
+                    !process.stdout.isTTY
+                        ? 'silent'
+                        : 'default',
                 rendererOptions: {
                     showErrorMessage: false,
                     showTimer: true

package/lib/commands/status.js

@@ -23,6 +23,7 @@ module.exports = (yargs) => {
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {},
         async (args) => {
+            const silent = /** @type {boolean} */ (args.silent)
             const tasks = new Listr(
                 [
                     checkRequirements(),
@@ -58,7 +59,9 @@ module.exports = (yargs) => {
                 {
                     concurrent: false,
                     exitOnError: false,
-                    ctx: { throwMagentoVersionMissing: true, ...args },
+                    ctx: { throwMagentoVersionMissing: true, ...args, silent },
+                    renderer:
+                        silent || !process.stdout.isTTY ? 'silent' : 'default',
                     rendererOptions: { collapse: false, clearOutput: false }
                 }
             )

package/lib/commands/stop.js

@@ -10,16 +10,20 @@ module.exports = (yargs) => {
         'Stop the application.',
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {},
-        async () => {
+        async (args) => {
+            const silent = /** @type {boolean} */ (args.silent)
             const tasks = new Listr(stop(), {
                 concurrent: false,
                 exitOnError: true,
-                rendererOptions: {
-                    collapse: false
-                },
                 ctx: {
                     throwMagentoVersionMissing: true,
-                    projectPath: process.cwd()
+                    projectPath: process.cwd(),
+                    silent
+                },
+                renderer:
+                    silent || !process.stdout.isTTY ? 'silent' : 'default',
+                rendererOptions: {
+                    collapse: false
                 }
             })
 

package/lib/config/check-configuration-file.js

@@ -49,13 +49,15 @@ const checkConfigurationFile = () => ({
             }
 
             if (!magentoConfiguration) {
-                const magentoEdition = await task.prompt({
-                    type: 'Select',
-                    message: `Please select Magento edition you want to install.
+                const magentoEdition = ctx.nonInteractive
+                    ? 'Community'
+                    : await task.prompt({
+                          type: 'Select',
+                          message: `Please select Magento edition you want to install.
 
 Note that Enterprise edition requires Magento Enterprise License keys.`,
-                    choices: ['Community', 'Enterprise']
-                })
+                          choices: ['Community', 'Enterprise']
+                      })
 
                 magentoConfiguration = deepmerge(defaultMagentoConfig, {
                     edition: magentoEdition.toLowerCase()

package/lib/config/docker.js

@@ -232,7 +232,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 name: `${prefix}_php_with_xdebug`,
                 connectCommand: ['/bin/sh'],
                 execCommandEnv: {
-                    XDEBUG_TRIGGER: 'PHPSTORM'
+                    XDEBUG_TRIGGER: 'PHPSTORM',
+                    XDEBUG_SESSION: 'PHPSTORM'
                 },
                 dependsOn: ['mariadb', 'redis', 'elasticsearch'],
                 user:

package/lib/config/get-magento-version-config.js

@@ -48,6 +48,8 @@ const getMagentoVersion = () => ({
                     const { magentoVersion: defaultMagentoVersion } =
                         defaultConfiguration
                     magentoVersion = defaultMagentoVersion
+                } else if (ctx.nonInteractive) {
+                    magentoVersion = defaultConfiguration.magento
                 } else {
                     let promptSkipper = false
                     const timer = async () => {

package/lib/tasks/database/create-magento-user.js

@@ -1,4 +1,5 @@
 const mysql2 = require('mysql2/promise')
+const sleep = require('../../util/sleep')
 const defaultMagentoUser = require('./default-magento-user')
 
 /**
@@ -8,12 +9,31 @@ const createMagentoUser = () => ({
     title: 'Creating Magento user',
     task: async (ctx, task) => {
         const { mariadb } = ctx.config.docker.getContainers()
-        const connection = await mysql2.createConnection({
-            host: '127.0.0.1',
-            port: ctx.ports.mariadb,
-            user: 'root',
-            password: mariadb.env.MARIADB_ROOT_PASSWORD
-        })
+
+        /** @type {import('mysql2/promise').Connection | undefined} */
+        let connection
+        const maxTries = 20
+
+        for (let tries = 1; tries <= maxTries; tries++) {
+            try {
+                connection = await mysql2.createConnection({
+                    host: '127.0.0.1',
+                    port: ctx.ports.mariadb,
+                    user: 'root',
+                    password: mariadb.env.MARIADB_ROOT_PASSWORD
+                })
+                break
+            } catch (e) {
+                if (tries === maxTries) {
+                    throw e
+                }
+                await sleep(1000)
+            }
+        }
+
+        if (!connection) {
+            throw new Error('Failed to connect to MariaDB')
+        }
 
         const result = await connection.query(
             'select Host, User from mysql.user;'

package/lib/tasks/database/fix-db.js

@@ -36,11 +36,13 @@ const fixDB = () => ({
                     title: 'Deleting customers data',
                     skip: ({ withCustomersData }) => withCustomersData,
                     task: async (ctx, subTask) => {
-                        const deleteCustomerData = await subTask.prompt({
-                            type: 'Confirm',
-                            message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
+                        const deleteCustomerData = ctx.nonInteractive
+                            ? false
+                            : await subTask.prompt({
+                                  type: 'Confirm',
+                                  message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
 This will reduce database size and remove possible interference for your setup.`
-                        })
+                              })
 
                         if (!deleteCustomerData) {
                             subTask.skip()

package/lib/tasks/database/import-dump-to-database.js

@@ -60,25 +60,27 @@ const runSetGlobalLogBinTrustFunctionCreatorsCommand = () => ({
 const deleteDatabaseBeforeImportingDumpPrompt = () => ({
     title: 'Deleting magento database before importing dump',
     task: async (ctx, task) => {
-        const deleteDatabaseMagentoChoice = await task.prompt({
-            type: 'Select',
-            message: `Before importing database dump, would you like to delete existing database?
+        const deleteDatabaseMagentoChoice = ctx.nonInteractive
+            ? 'delete'
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Before importing database dump, would you like to delete existing database?
 
 It is possible that dump might interfere with existing data in database.
 
 Note that you will lose your existing database!`,
-            choices: [
-                {
-                    name: 'delete',
-                    message: 'YES I WANT TO DELETE magento DATABASE!'
-                },
-                {
-                    name: 'skip',
-                    message:
-                        "NO I DON'T WANT TO DELETE magento DATABASE! (Skip this step)"
-                }
-            ]
-        })
+                  choices: [
+                      {
+                          name: 'delete',
+                          message: 'YES I WANT TO DELETE magento DATABASE!'
+                      },
+                      {
+                          name: 'skip',
+                          message:
+                              "NO I DON'T WANT TO DELETE magento DATABASE! (Skip this step)"
+                      }
+                  ]
+              })
 
         if (deleteDatabaseMagentoChoice === 'delete') {
             await ctx.databaseConnection.query(
@@ -103,22 +105,24 @@ const executeImportDumpSQL = () => ({
         const { mariadb } = docker.getContainers(ports)
         const { binFileName } = overridenConfiguration.configuration.mariadb
 
-        const userCredentialsForMariaDBCLI = await task.prompt({
-            type: 'Select',
-            message: `Which user do you want to use to import db in ${mariadb._} client?`,
-            choices: [
-                {
-                    name: `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`,
-                    message: `root (${logger.style.command(
-                        'Probably safest option'
-                    )})`
-                },
-                {
-                    name: `--user=${defaultMagentoUser.user} --password=${defaultMagentoUser.password}`,
-                    message: `${defaultMagentoUser.user}`
-                }
-            ]
-        })
+        const userCredentialsForMariaDBCLI = ctx.nonInteractive
+            ? `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Which user do you want to use to import db in ${mariadb._} client?`,
+                  choices: [
+                      {
+                          name: `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`,
+                          message: `root (${logger.style.command(
+                              'Probably safest option'
+                          )})`
+                      },
+                      {
+                          name: `--user=${defaultMagentoUser.user} --password=${defaultMagentoUser.password}`,
+                          message: `${defaultMagentoUser.user}`
+                      }
+                  ]
+              })
 
         const importCommand = `docker exec ${mariadb.name} bash -c "${binFileName} ${userCredentialsForMariaDBCLI} magento < ./dump.sql"`
 
@@ -137,11 +141,13 @@ const executeImportDumpSQL = () => ({
             })
         } catch (e) {
             if (e.message.includes("Unknown collation: 'utf8mb4_0900_ai_ci'")) {
-                const confirmFixingCollation = await task.prompt({
-                    type: 'Select',
-                    message: `We got the following error while trying to import ${logger.style.file(
-                        'dump.sql'
-                    )}!
+                const confirmFixingCollation = ctx.nonInteractive
+                    ? 'yes'
+                    : await task.prompt({
+                          type: 'Select',
+                          message: `We got the following error while trying to import ${logger.style.file(
+                              'dump.sql'
+                          )}!
 
 ${e.message}
 
@@ -150,18 +156,19 @@ ${logger.style.command(
     "sed -i 's/utf8mb4_0900_ai_ci/utf8mb4_general_ci/g' dump.sql"
 )}
 `,
-                    choices: [
-                        {
-                            name: 'yes',
-                            message:
-                                'Yes, run the following commands, I reaaaalllyy want dump to work! (this will not edit original dump.sql)'
-                        },
-                        {
-                            name: 'no',
-                            message: 'Okay, I got it. Will try to fix myself'
-                        }
-                    ]
-                })
+                          choices: [
+                              {
+                                  name: 'yes',
+                                  message:
+                                      'Yes, run the following commands, I reaaaalllyy want dump to work! (this will not edit original dump.sql)'
+                              },
+                              {
+                                  name: 'no',
+                                  message:
+                                      'Okay, I got it. Will try to fix myself'
+                              }
+                          ]
+                      })
 
                 if (confirmFixingCollation === 'yes') {
                     task.output = 'Running fix command...'

package/lib/tasks/database/import-remote-db/ssh/index.js

@@ -19,11 +19,13 @@ const sshDb = () => ({
         ctx.ssh = ssh
 
         if (!password) {
-            const privateKey = await task.prompt({
-                type: 'Input',
-                message: `Please enter your private key location to connect to ${hostname}\n`,
-                initial: `${os.homedir()}/.ssh/id_rsa`
-            })
+            const privateKey = ctx.nonInteractive
+                ? `${os.homedir()}/.ssh/id_rsa`
+                : await task.prompt({
+                      type: 'Input',
+                      message: `Please enter your private key location to connect to ${hostname}\n`,
+                      initial: `${os.homedir()}/.ssh/id_rsa`
+                  })
 
             if (!(await pathExists(privateKey))) {
                 throw new KnownError(`Private key not found: ${privateKey}`)
@@ -31,11 +33,13 @@ const sshDb = () => ({
 
             ctx.privateKey = privateKey
 
-            const passphrase = await task.prompt({
-                type: 'Input',
-                message:
-                    'Please enter your private key passphrase (if you have it)'
-            })
+            const passphrase = ctx.nonInteractive
+                ? undefined
+                : await task.prompt({
+                      type: 'Input',
+                      message:
+                          'Please enter your private key passphrase (if you have it)'
+                  })
 
             ctx.passphrase = passphrase || undefined
 
@@ -67,14 +71,16 @@ const sshDb = () => ({
         const remoteFiles = remoteFilesOutput.split('\n')
 
         if (dumpFileNames.every((dumpFile) => remoteFiles.includes(dumpFile))) {
-            ctx.makeRemoteDumps = await task.prompt({
-                type: 'Toggle',
-                enabled: 'Yes!',
-                disabled: 'No, just download and import them.',
-                message: `We found dump files on remote server.
+            ctx.makeRemoteDumps = ctx.nonInteractive
+                ? true
+                : await task.prompt({
+                      type: 'Toggle',
+                      enabled: 'Yes!',
+                      disabled: 'No, just download and import them.',
+                      message: `We found dump files on remote server.
   Do you want to replace them with new dump files or use existing ones?
 `
-            })
+                  })
         } else {
             ctx.makeRemoteDumps = true
         }

package/lib/tasks/database/import-remote-db/ssh/regular-server.js

@@ -20,15 +20,17 @@ const regularSSHServer = () => ({
             /**
              * @type {string}
              */
-            const dumpCommand = await task.prompt({
-                type: 'Input',
-                message: `Edit (if needed) command to connect to remote mysql server and create dump files.
+            const dumpCommand = ctx.nonInteractive
+                ? databaseDumpCommandWithOptions.join(' ')
+                : await task.prompt({
+                      type: 'Input',
+                      message: `Edit (if needed) command to connect to remote mysql server and create dump files.
 Do not enter "--result-file" option, we need to control that part.
 
 (documentation reference available here: https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html)
 `,
-                initial: databaseDumpCommandWithOptions.join(' ')
-            })
+                      initial: databaseDumpCommandWithOptions.join(' ')
+                  })
 
             if (dumpCommand.includes('--result-file')) {
                 throw new KnownError(

package/lib/tasks/execute.js

@@ -38,12 +38,9 @@ const executeTask = async (argv) => {
         {
             concurrent: false,
             exitOnError: true,
-            ctx: /** @type {any} */ ({ throwMagentoVersionMissing: true }),
-            renderer: nonInteractive
-                ? 'silent'
-                : process.stdout.isTTY
-                ? 'default'
-                : 'silent',
+            ctx: { throwMagentoVersionMissing: true, nonInteractive },
+            renderer:
+                nonInteractive || !process.stdout.isTTY ? 'silent' : 'default',
             rendererOptions: { collapse: false, clearOutput: true }
         }
     )

package/lib/tasks/import-dump.js

@@ -51,22 +51,24 @@ const importDump = () => ({
                     },
                     task: async (subCtx, subTask) => {
                         const doYouWantToRunSetupOnEmptyDB =
-                            await subTask.prompt({
-                                type: 'Select',
-                                message: `We detected that Magento is not installed in database. Do you want to install Magento in database BEFORE importing database dump?`,
-                                choices: [
-                                    {
-                                        name: 'try-install',
-                                        message:
-                                            'Try installing Magento before importing database'
-                                    },
-                                    {
-                                        name: 'skip',
-                                        message:
-                                            'Skip installing Magento and import database dump right away!'
-                                    }
-                                ]
-                            })
+                            subCtx.nonInteractive
+                                ? 'skip'
+                                : await subTask.prompt({
+                                      type: 'Select',
+                                      message: `We detected that Magento is not installed in database. Do you want to install Magento in database BEFORE importing database dump?`,
+                                      choices: [
+                                          {
+                                              name: 'try-install',
+                                              message:
+                                                  'Try installing Magento before importing database'
+                                          },
+                                          {
+                                              name: 'skip',
+                                              message:
+                                                  'Skip installing Magento and import database dump right away!'
+                                          }
+                                      ]
+                                  })
 
                         if (doYouWantToRunSetupOnEmptyDB === 'skip') {
                             subTask.skip()

package/lib/tasks/magento/enable-magento-composer-plugins.js

@@ -180,16 +180,18 @@ const enableMagentoComposerPlugins = () => ({
                 })
             }
 
-            const answerForEnablingPlugins = await task.prompt({
-                type: 'Select',
-                message: `Composer 2.2 requires manually allowing composer-plugins to run.
+            const answerForEnablingPlugins = ctx.nonInteractive
+                ? 'all-individual'
+                : await task.prompt({
+                      type: 'Select',
+                      message: `Composer 2.2 requires manually allowing composer-plugins to run.
 Magento requires the following plugins to correctly operate:
 
 ${missingPluginsFromAllowPlugins.map((p) => logger.style.code(p)).join('\n')}
 
 Do you want to enable them all or disable some of them?`,
-                choices: pluginOptions
-            })
+                      choices: pluginOptions
+                  })
 
             switch (answerForEnablingPlugins.toLowerCase()) {
                 case 'all': {

package/lib/tasks/magento/setup-magento/index-products.js

@@ -22,21 +22,23 @@ const indexProducts = () => ({
             ({ status }) => status !== 'valid'
         )
 
-        const doYouWantToSkipIndexingPart = await task.prompt({
-            type: 'Select',
-            message: `Do you want to index the products? (There are ${invalidIndexers.length} invalid indexers, total indexers: ${data[0].length})\n`,
-            choices: [
-                {
-                    name: 'index',
-                    message: 'Yes, index them please'
-                },
-                {
-                    name: 'skip',
-                    message:
-                        'Skip, do not index them. I will do it later myself'
-                }
-            ]
-        })
+        const doYouWantToSkipIndexingPart = ctx.nonInteractive
+            ? 'index'
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Do you want to index the products? (There are ${invalidIndexers.length} invalid indexers, total indexers: ${data[0].length})\n`,
+                  choices: [
+                      {
+                          name: 'index',
+                          message: 'Yes, index them please'
+                      },
+                      {
+                          name: 'skip',
+                          message:
+                              'Skip, do not index them. I will do it later myself'
+                      }
+                  ]
+              })
 
         if (doYouWantToSkipIndexingPart === 'skip') {
             task.skip()

package/lib/tasks/magento/setup-magento/install-magento.js

@@ -51,26 +51,28 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
                 response && response.length > 0 && response[0]
 
             if (usersWithUsernameAdmin && usersWithUsernameAdmin.length > 0) {
-                const confirmDeleteAdminUsers = await task.prompt({
-                    type: 'Select',
-                    message: `In order to install Magento in database you will need to delete admin user with username ${logger.style.command(
-                        'admin'
-                    )}`,
-                    choices: [
-                        {
-                            name: 'delete-all',
-                            message: `Delete all admin users (${logger.style.code(
-                                'Recommended'
-                            )})`
-                        },
-                        {
-                            name: 'delete-only-admin',
-                            message: `Delete only admin user with ${logger.style.command(
-                                'admin'
-                            )} username`
-                        }
-                    ]
-                })
+                const confirmDeleteAdminUsers = ctx.nonInteractive
+                    ? 'delete-all'
+                    : await task.prompt({
+                          type: 'Select',
+                          message: `In order to install Magento in database you will need to delete admin user with username ${logger.style.command(
+                              'admin'
+                          )}`,
+                          choices: [
+                              {
+                                  name: 'delete-all',
+                                  message: `Delete all admin users (${logger.style.code(
+                                      'Recommended'
+                                  )})`
+                              },
+                              {
+                                  name: 'delete-only-admin',
+                                  message: `Delete only admin user with ${logger.style.command(
+                                      'admin'
+                                  )} username`
+                              }
+                          ]
+                      })
 
                 await databaseConnection.query('SET FOREIGN_KEY_CHECKS = 0;')
 
@@ -183,7 +185,7 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
                 --cache-backend='redis' \
                 --cache-backend-redis-server='${hostMachine}' \
                 --cache-backend-redis-port='${ports.redis}' \
-                --cache-backend-redis-db='0't \
+                --cache-backend-redis-db='0' \
                 --db-host='${hostMachine}:${ports.mariadb}' \
                 --db-name='${defaultMagentoDatabase}' \
                 --db-user='${defaultMagentoUser.user}' \
@@ -219,21 +221,23 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
                     )
                 )
             ) {
-                const confirmToWipeEnvPhp = await task.prompt({
-                    type: 'Confirm',
-                    message: `We detected that your encryption key in ${logger.style.file(
-                        'app/etc/env.php'
-                    )} file is not accepted by Magento installer.
+                const confirmToWipeEnvPhp = ctx.nonInteractive
+                    ? true
+                    : await task.prompt({
+                          type: 'Confirm',
+                          message: `We detected that your encryption key in ${logger.style.file(
+                              'app/etc/env.php'
+                          )} file is not accepted by Magento installer.
 To fix this issue we will need to ${logger.style.misc(
-                        'DELETE'
-                    )} ${logger.style.file(
-                        'app/etc/env.php'
-                    )} file. It will be recreated but existing encryption key but if you any custom configuration in it will be lost.
+                              'DELETE'
+                          )} ${logger.style.file(
+                              'app/etc/env.php'
+                          )} file. It will be recreated but existing encryption key but if you any custom configuration in it will be lost.
 
 Without this you will not be able to install Magento at this moment.
 
 Do you want to continue?`
-                })
+                      })
 
                 if (confirmToWipeEnvPhp) {
                     try {

package/lib/tasks/requirements/composer-credentials.js

@@ -209,23 +209,25 @@ const checkComposerCredentials = () => ({
 
                 if (composerAuthInRcFile) {
                     doConfigure = false
-                    const loadCredentialsFrom = await task.prompt({
-                        type: 'Confirm',
-                        message: `We detected that you have ${logger.style.misc(
-                            'COMPOSER_AUTH'
-                        )} environment variable set in ${logger.style.file(
-                            shellConfigFilePath
-                        )} file,
+                    const loadCredentialsFrom = ctx.nonInteractive
+                        ? true
+                        : await task.prompt({
+                              type: 'Confirm',
+                              message: `We detected that you have ${logger.style.misc(
+                                  'COMPOSER_AUTH'
+                              )} environment variable set in ${logger.style.file(
+                                  shellConfigFilePath
+                              )} file,
 but we do not see this variable inside ${logger.style.code(
-                            'magento-scripts'
-                        )} process.
+                                  'magento-scripts'
+                              )} process.
 
 ${logger.style.misc(
     "! Don't forget to reload your shell after process is finished !"
 )}
 
 Would you like to load them now?`
-                    })
+                          })
 
                     if (loadCredentialsFrom) {
                         const credentialsLine = lines.find((line) =>
@@ -249,6 +251,19 @@ Would you like to load them now?`
             }
 
             if (doConfigure) {
+                if (ctx.nonInteractive) {
+                    throw new KnownError(
+                        `Composer credentials are required but were not found in ${logger.style.misc(
+                            '$COMPOSER_AUTH'
+                        )} or ${logger.style.file('./auth.json')}.
+
+Provide them non-interactively by setting the ${logger.style.misc(
+                            '$COMPOSER_AUTH'
+                        )} environment variable or by creating an ${logger.style.file(
+                            './auth.json'
+                        )} file, then run the command again.`
+                    )
+                }
                 return task.newListr(configureComposerCredentials())
             }
         }
@@ -306,20 +321,22 @@ Do you want to remove them now? File will be overwritten.`
                         : null
 
                 if (message) {
-                    const response = await task.prompt({
-                        message,
-                        type: 'Select',
-                        choices: [
-                            {
-                                name: 'overwrite',
-                                message: 'Yes, please!'
-                            },
-                            {
-                                name: 'skip',
-                                message: "No, I know what I'm doing"
-                            }
-                        ]
-                    })
+                    const response = ctx.nonInteractive
+                        ? 'skip'
+                        : await task.prompt({
+                              message,
+                              type: 'Select',
+                              choices: [
+                                  {
+                                      name: 'overwrite',
+                                      message: 'Yes, please!'
+                                  },
+                                  {
+                                      name: 'skip',
+                                      message: "No, I know what I'm doing"
+                                  }
+                              ]
+                          })
 
                     if (response === 'overwrite') {
                         if (repoMagentoCredentials.username) {

package/lib/tasks/requirements/docker/context.js

@@ -48,29 +48,31 @@ const checkDockerDesktopContext = () => ({
                 return
             }
 
-            const confirmContextChange = await task.prompt({
-                type: 'Select',
-                message: `Do you want to change current Docker Desktop context (${logger.style.code(
-                    currentlyUsedContext.Name
-                )}) to ${logger.style.code('default')}?`,
-                choices: [
-                    {
-                        name: 'yes',
-                        message: 'Yes'
-                    },
-                    {
-                        name: 'no',
-                        message:
-                            "No, I don't know what this means, but you can ask again on next start."
-                    },
-                    {
-                        name: 'skip',
+            const confirmContextChange = ctx.nonInteractive
+                ? 'no'
+                : await task.prompt({
+                      type: 'Select',
+                      message: `Do you want to change current Docker Desktop context (${logger.style.code(
+                          currentlyUsedContext.Name
+                      )}) to ${logger.style.code('default')}?`,
+                      choices: [
+                          {
+                              name: 'yes',
+                              message: 'Yes'
+                          },
+                          {
+                              name: 'no',
+                              message:
+                                  "No, I don't know what this means, but you can ask again on next start."
+                          },
+                          {
+                              name: 'skip',
 
-                        message:
-                            "I do know what this means and I DON'T want to change context for Docker. Also, save this answer to never ask again."
-                    }
-                ]
-            })
+                              message:
+                                  "I do know what this means and I DON'T want to change context for Docker. Also, save this answer to never ask again."
+                          }
+                      ]
+                  })
 
             if (confirmContextChange === 'skip') {
                 cmaGlobalConfig.set(

package/lib/tasks/requirements/docker/permissions.js

@@ -21,22 +21,24 @@ const checkDockerSocketPermissions = () => ({
         } catch (e) {
             // check for permission
             if (Math.abs(e.errno) === Math.abs(os.constants.errno.EACCES)) {
-                const confirmPrompt = await task.prompt({
-                    type: 'Confirm',
-                    message: `We detected that your Docker socket, located in ${logger.style.file(
-                        dockerSocketPath
-                    )}, have permissions set, that prevents user (${logger.style.misc(
-                        os.userInfo().username
-                    )}) from accessing it.
+                const confirmPrompt = ctx.nonInteractive
+                    ? false
+                    : await task.prompt({
+                          type: 'Confirm',
+                          message: `We detected that your Docker socket, located in ${logger.style.file(
+                              dockerSocketPath
+                          )}, have permissions set, that prevents user (${logger.style.misc(
+                              os.userInfo().username
+                          )}) from accessing it.
 
 We can fix it by running the following command: ${logger.style.command(
-                        fixCommand
-                    )}
+                              fixCommand
+                          )}
 
 Would you like to fix this permission issue?
 
 Otherwise installation will likely fail.`
-                })
+                      })
 
                 if (confirmPrompt) {
                     return task.newListr(executeSudoCommand(fixCommand))

package/lib/tasks/requirements/docker/running-status.js

@@ -61,11 +61,13 @@ const checkDockerStatusMacOS = () => ({
                 result.includes('Is the docker daemon running?') ||
                 result.includes('docker: command not found')
             ) {
-                const dockerOpenAppConfirmation = await task.prompt({
-                    type: 'Confirm',
-                    message:
-                        'Looks like Docker is not running, would you like us to open a Docker for Mac application and wait for it to start up?'
-                })
+                const dockerOpenAppConfirmation = ctx.nonInteractive
+                    ? false
+                    : await task.prompt({
+                          type: 'Confirm',
+                          message:
+                              'Looks like Docker is not running, would you like us to open a Docker for Mac application and wait for it to start up?'
+                      })
 
                 if (
                     dockerOpenAppConfirmation &&
@@ -136,12 +138,14 @@ const checkDockerStatusLinux = () => ({
 
         if (engine.exists) {
             if (!engine.isEnabled && !engine.isRunning) {
-                const dockerStartConfirmation = await task.prompt({
-                    type: 'Confirm',
-                    message: `Looks like Docker Engine is not enabled and not running, would you like to enable and run it?
+                const dockerStartConfirmation = ctx.nonInteractive
+                    ? false
+                    : await task.prompt({
+                          type: 'Confirm',
+                          message: `Looks like Docker Engine is not enabled and not running, would you like to enable and run it?
 
     This action requires root privileges.`
-                })
+                      })
 
                 if (dockerStartConfirmation) {
                     await engine.service.enableAndStart()
@@ -150,12 +154,14 @@ const checkDockerStatusLinux = () => ({
                 }
                 task.skip('User skipped running Docker')
             } else if (!engine.isRunning) {
-                const dockerStartConfirmation = await task.prompt({
-                    type: 'Confirm',
-                    message: `Looks like Docker Engine is not running, would you like to run it?
+                const dockerStartConfirmation = ctx.nonInteractive
+                    ? false
+                    : await task.prompt({
+                          type: 'Confirm',
+                          message: `Looks like Docker Engine is not running, would you like to run it?
 
     This action requires root privileges.`
-                })
+                      })
 
                 if (dockerStartConfirmation) {
                     await engine.service.start()
@@ -166,12 +172,14 @@ const checkDockerStatusLinux = () => ({
             }
         } else if (desktop.exists) {
             if (!desktop.isEnabled && !desktop.isRunning) {
-                const dockerStartConfirmation = await task.prompt({
-                    type: 'Confirm',
-                    message: `Looks like Docker Desktop is not enabled and not running, would you like to enable and run it?
+                const dockerStartConfirmation = ctx.nonInteractive
+                    ? false
+                    : await task.prompt({
+                          type: 'Confirm',
+                          message: `Looks like Docker Desktop is not enabled and not running, would you like to enable and run it?
 
     This action requires root privileges.`
-                })
+                      })
 
                 if (dockerStartConfirmation) {
                     await desktop.service.enableAndStart()
@@ -180,12 +188,14 @@ const checkDockerStatusLinux = () => ({
                 }
                 task.skip('User skipped running Docker')
             } else if (!desktop.isRunning) {
-                const dockerStartConfirmation = await task.prompt({
-                    type: 'Confirm',
-                    message: `Looks like Docker Desktop is not running, would you like to run it?
+                const dockerStartConfirmation = ctx.nonInteractive
+                    ? false
+                    : await task.prompt({
+                          type: 'Confirm',
+                          message: `Looks like Docker Desktop is not running, would you like to run it?
 
     This action requires root privileges.`
-                })
+                      })
 
                 if (dockerStartConfirmation) {
                     await desktop.service.start()

package/lib/tasks/start.js

@@ -176,7 +176,7 @@ const start = () => ({
                 {
                     title: 'Opening browser',
                     skip: async (ctx) => {
-                        if (ctx.noOpen) {
+                        if (ctx.open === false) {
                             return true
                         }
 

package/lib/util/ensure-agents-md.js

@@ -0,0 +1,79 @@
+const fs = require('fs')
+const path = require('path')
+
+const AGENTS_MD_CONTENT = `# CMA (magento-scripts) — AI/CI Reference
+
+> Auto-generated by magento-scripts. Do not delete.
+
+## Critical
+
+- **Cannot run as root** — exits immediately with code 1, no override.
+- **Non-TTY safe** — silent renderer activates automatically in CI/pipes; no \`-q\` needed.
+- **Do NOT use \`--\` with exec** — it gets passed as the command and fails. Correct: \`magento-scripts exec php bin/magento cache:flush\`
+- **\`cli\` is TTY-only** — use \`exec php bin/magento <cmd>\` in automation instead.
+- **\`import-db\` is self-contained** — it stops running containers, assigns ports, starts services, waits for MariaDB, and imports. Do NOT run \`start\` before or between \`import-db\` attempts — that creates port conflicts. Just run \`import-db\` directly.
+- **Do NOT run \`start\` then \`import-db\`** — each command manages its own container lifecycle. Running both creates split-brain port assignments. Use one or the other.
+- **Long-running commands** — \`start\` and \`import-db\` can take 10+ minutes (container setup, large dumps). Set timeouts to at least 600000ms (10 min) or run without a timeout.
+- **Shell escaping** — Avoid \`!\` in SQL strings passed via \`exec\` (e.g., \`!=\`), as the shell may interpret it. Use SQL alternatives like \`<>\` instead of \`!=\`.
+
+## Commands
+
+| Command | What it does | Key flags |
+|---------|-------------|-----------|
+| \`start\` | Start Docker environment | \`--no-open\`, \`--skip-setup\`, \`--port\` |
+| \`stop\` | Stop all containers | — |
+| \`status\` | Show container/DB status | — |
+| \`exec <container> [cmd...]\` | Run command in container | use \`--\` before flags |
+| \`import-db [file]\` | Import SQL dump into MariaDB | \`-y\` (non-interactive), \`--remote-db=ssh://user@host\` |
+| \`logs <container>\` | Stream container logs | \`--tail N\`, \`--follow\` |
+| \`cleanup\` | Remove cached/generated files | \`--force\` |
+| \`cli\` | Interactive shell (TTY only) | — |
+| \`link <path>\` | Link ScandiPWA theme | — |
+
+## Containers
+
+\`php\`, \`phpWithXdebug\`, \`nginx\`, \`sslTerminator\`, \`redis\`, \`mariadb\`, \`elasticsearch\`, \`maildev\`, \`varnish\` (if enabled)
+
+## Examples
+
+\`\`\`bash
+magento-scripts start --no-open --skip-setup
+magento-scripts import-db dump.sql -y
+magento-scripts import-db -y --remote-db=ssh://user@host
+magento-scripts exec php bin/magento cache:flush
+magento-scripts exec php bin/magento indexer:reindex
+
+# Query MariaDB (use mariadb binary, not mysql)
+magento-scripts exec mariadb mariadb -u magento -pmagento magento -e "SELECT COUNT(*) FROM store"
+magento-scripts logs magento --tail 100
+magento-scripts stop
+\`\`\`
+`
+
+/**
+ * Write AGENTS.md and CLAUDE.md to the current working directory if they do not already exist.
+ * This gives AI agents and CI pipelines a command reference for the project.
+ */
+function ensureAgentsMd() {
+    const cwd = process.cwd()
+
+    const agentsDest = path.join(cwd, 'AGENTS.md')
+    if (!fs.existsSync(agentsDest)) {
+        try {
+            fs.writeFileSync(agentsDest, AGENTS_MD_CONTENT, 'utf8')
+        } catch (e) {
+            // Non-fatal — silently skip if the directory is not writable
+        }
+    }
+
+    const claudeDest = path.join(cwd, 'CLAUDE.md')
+    if (!fs.existsSync(claudeDest)) {
+        try {
+            fs.writeFileSync(claudeDest, '@AGENTS.md\n', 'utf8')
+        } catch (e) {
+            // Non-fatal
+        }
+    }
+}
+
+module.exports = ensureAgentsMd

package/lib/util/execute-in-container.js

@@ -30,18 +30,16 @@ const joinCommandArgs = (...args) =>
  * @param {{ containerName: string, commands: string[], user?: string, env?: Record<string, string> }} param0
  */
 const executeInContainer = ({ containerName, commands, user, env }) => {
-    if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode')
-        process.exit(1)
-    }
     const [commandBin, ...commandsArgs] = commands
 
+    const isTTY = process.stdin.isTTY
+
     const execArgs = execCommand({
         container: containerName,
         command: commandBin,
         user,
-        tty: true,
-        interactive: true,
+        tty: isTTY,
+        interactive: isTTY,
         env: env || {}
     })
     const [command, ...args] = execArgs
@@ -91,18 +89,14 @@ const executeInContainerNonInteractive = async ({
  * @param {string[]} commands
  */
 const runInContainer = async (options, commands) => {
-    if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode')
-        process.exit(1)
-    }
-
+    const isTTY = process.stdin.isTTY
     const [commandBin, ...commandsArgs] = commands
 
     const runResult = await run(
         {
             ...options,
             command: joinCommandArgs(commandBin, ...commandsArgs),
-            tty: true,
+            tty: isTTY,
             detach: false,
             rm: true
         },

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "2.4.11",
+    "version": "2.4.12-alpha.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -59,5 +59,5 @@
         "@types/node": "^20.14.11",
         "@types/yargs": "^17.0.32"
     },
-    "gitHead": "64c177af194cf32de4d8ae08116f016d30ec7f01"
+    "gitHead": "0fe2409c4e619ff985cf90a7f3d6cc4d45ca2552"
 }

package/typings/context.d.ts

@@ -8,6 +8,7 @@ import { PHPStormConfig } from './phpstorm'
 
 export interface ListrContext {
     noOpen?: boolean
+    open?: boolean
     skipSetup?: boolean
     resetGlobalConfig?: boolean
     withCustomersData?: boolean
@@ -159,4 +160,14 @@ export interface ListrContext {
     dockerClientData?: DockerVersionResult['Client']
     dockerVersion?: DockerVersionResult['Server']['Version']
     dockerMemoryLimit: number
+    silent?: boolean
+    nonInteractive?: boolean
+    deleteDb?: 'always' | 'never' | 'ask'
+    dbUser?: 'root' | 'magento'
+    fixCollation?: 'auto' | 'never' | 'ask'
+    installMagentoEmptyDb?: 'yes' | 'no' | 'ask'
+    privateKey?: string
+    passphrase?: string
+    makeRemoteDumps?: boolean
+    remoteDumpCommand?: string
 }