n98-magerun2 Documentation

n98-magerun2 organizes its commands into namespaces based on functionality. Common namespaces include:

• admin: Manage Magento admin users and settings (e.g., admin:user:list, admin:user:create).
• cache: Manage Magento cache systems (e.g., cache:clean, cache:flush).
• config: Manage store configurations and environment settings (e.g., config:store:get, config:env:set).
• customer: Manage customer accounts (e.g., customer:create, customer:list).
• db: Database operations (e.g., db:dump, db:import, db:query).
• dev: Developer tools, code generation, and debugging (e.g., dev:module:create, dev:console).
• eav: Manage Entity-Attribute-Value attributes (e.g., eav:attribute:list).
• generation: Code generation processes (e.g., generation:flush).
• giftcard: Manage gift cards (e.g., giftcard:create, giftcard:info).
• index: Manage indexers (e.g., indexer:list, indexer:trigger:recreate).
• install: Install Magento (install).
• integration: Manage Magento integrations (e.g., integration:list, integration:delete).
• mageforge: Install and manage the MageForge tool (mageforge:install).
• magerun: n98-magerun2 internal configuration and tools (e.g., magerun:config:info).
• mcp: Model Context Protocol (MCP) server integration (mcp:server:start).
• routes: View and manage Magento routes (routes:list).
• script: Run sequences of commands from a file (script).
• sys: System-level info, maintenance, and checks (e.g., sys:info, sys:cron:list).

n98-magerun2 uses a layered configuration system where settings are loaded and merged from multiple sources. The process is orchestrated by the N98\Magento\Application class during its init() method and occurs in two primary stages:

1. Partial Config Load (Stage One): Config::loadPartialConfig() is called to load basic configuration files (dist, system, user) to establish initial settings and command aliases.
2. Magento Detection: The application detects the Magento root directory, which determines the location of project-specific configurations.
3. Full Config Load (Stage Two): ConfigurationLoader::loadStageTwo() loads additional files, such as project and stop-file configs, using the discovered Magento root.

Configuration Merging Order: Files are merged in the following order, with later files overriding earlier ones:

1. Dist (default)
2. System
3. User
4. Plugin
5. Project
6. Stop-file (if present)