Skip to main content

Welcome to n98-magerun2!

Welcome! n98-magerun2 is the essential command-line companion for anyone working with Adobe Commerce, Magento, or Mage-OS. It simplifies complex tasks, automates repetitive work, and gives you powerful control over your e-commerce platform directly from the terminal.

It's famously known as the Swiss Army knife for Magento developers, system administrators, and DevOps professionals.

This version of the tool is specifically for modern Magento-based platforms. If you are working with the classic Magento 1 or OpenMage, please use the original n98-magerun.

🚀 Quick Start​

Ready to get n98-magerun2 up and running?

  1. Review Compatibility: Check the Compatibility Page to ensure it works with your Magento and PHP versions.
  2. Install: Follow our Installation Guide to add n98-magerun2 to your system or project.
  3. Explore Commands: Once installed, run n98-magerun2.phar to see all available commands, or browse the Command Documentation.

This will get you started quickly with the most important first steps.

‍👥 For Everyone: What does n98-magerun2 do?​

Think of n98-magerun2 as a powerful assistant. Many routine maintenance and development tasks for an e-commerce store require navigating through complex admin panels or writing custom scripts. This tool bundles hundreds of these operations into simple, repeatable commands.

For a store owner or project manager, this means your development team can work faster and more efficiently, saving time and reducing errors on critical tasks.

📖 User Guide​

See the Command Documentation for a full list of available commands and detailed usage instructions.

⚙️ For System Administrators & DevOps​

Automate, deploy, and manage your infrastructure with confidence. Magerun is built for scripting and provides powerful tools for system-level tasks.

  • Easy Installation: Install the tool system-wide or per-project.
  • Scripting & Automation: Integrate magerun commands seamlessly into your deployment and CI/CD pipelines.
  • System Inspection: Quickly check the status of caches, indexers, and other system requirements.
  • Hosting-Specific Commands: Benefit from commands tailored for various hosting environments.

Get your infrastructure set up:

👩‍💻 For Developers​

Stop clicking through the admin and speed up your daily workflow. Magerun is your go-to tool for common development tasks.

  • Cache & Index Management: Instantly clean caches or reindex your entire store with a single command.
  • Database Access: Run direct SQL queries or manage database dumps without needing a separate client.
  • Code Scaffolding: Quickly create new modules, plugins, or controllers from templates.
  • Admin & Customer Management: Create admin users or inspect customer data directly from the command line.
  • Configuration: Easily change system configuration values without searching through the admin panel.

Ready to supercharge your development?

🤝 Contributing to n98-magerun2​

We welcome contributions from the community! Whether you want to report a bug, suggest an enhancement, or submit a pull request, please read our Contributing Guide to get started. Your input helps make n98-magerun2 better for everyone.