n98-magerun2 使用教程

n98-magerun2 使用教程

n98-magerun2 The swiss army knife for Magento developers, sysadmins and devops. The tool provides a huge set of well tested command line commands which save hours of work time. All commands are extendable by a module API. 项目地址: https://gitcode.com/gh_mirrors/n9/n98-magerun2

1. 项目介绍

n98-magerun2 是一个为 Magento 开发者、系统管理员和 DevOps 设计的命令行工具。它提供了一系列经过充分测试的命令行指令，可以极大地节省工作时间。所有指令都可以通过模块 API 进行扩展。

2. 项目快速启动

安装

有多种方式可以安装 n98-magerun2，以下是两种常用的方法：

下载并安装 Phar 文件

从文件服务器下载最新稳定的 n98-magerun2 phar 文件：

wget https://files.magerun.net/n98-magerun2.phar

或者如果你更喜欢使用 Curl：

curl -O https://files.magerun.net/n98-magerun2.phar

验证下载的文件，可以通过比较 SHA256 校验和：

shasum -a256 n98-magerun2.phar

也可以自动进行验证：

curl -sS -O https://files.magerun.net/n98-magerun2-latest.phar
curl -sS -o n98-magerun2-latest.phar.sha256 https://files.magerun.net/sha256.php?file=n98-magerun2-latest.phar
shasum -a 256 -c n98-magerun2-latest.phar.sha256

如果校验和一致，说明文件下载成功。

现在可以让 phar 文件具有可执行权限：

chmod +x ./n98-magerun2.phar

安装完成后，可以通过以下命令进行验证：

./n98-magerun2.phar --version

该命令应该能够成功执行，并显示 n98-magerun2 的版本号。

通过 Composer 安装

我们提供了一个特殊的 dist 包以通过 Composer 安装 phar 文件。更多详情请查看 Packagist。

注意：不推荐通过 Composer 安装，因为这无法与所有项目及 Magento 核心依赖兼容。请使用 phar 文件而非 Composer 版本。

使用

使用前，请确保切换到含有 Magento 安装的目录下。可以通过以下命令查看所有可用的指令：

n98-magerun2.phar list

或者，如果没有将 .phar 文件安装为系统全局，可以使用 PHP CLI 解释器调用：

php n98-magerun2.phar list

3. 应用案例和最佳实践

以下是一些典型的应用案例：

• 数据库备份：通过命令 db:dump 快速备份 Magento 数据库。
• 环境部署：使用 install 命令在新的服务器上快速部署 Magento 环境。
• 代码审查：运行 phpstan 或 php-cs-fixer 命令来审查和修复代码风格问题。

最佳实践建议：

• 总是先在测试环境中运行命令，确保了解每个命令的影响。
• 使用版本控制管理你的 Magento 安装和 n98-magerun2 配置。
• 通过自定义 n98-magerun2 的配置文件，优化你的工作流程。

4. 典型生态项目

n98-magerun2 是 Magento 生态系统中的一个重要工具，它通常与以下项目一同使用：

• Magento：n98-magerun2 为 Magento 提供了丰富的命令行工具。
• Composer：用于管理和安装 PHP 项目的依赖。
• Git：版本控制系统，用于跟踪代码更改和管理项目版本。

以上就是 n98-magerun2 的使用教程，希望对您的开发工作有所帮助。

n98-magerun2 The swiss army knife for Magento developers, sysadmins and devops. The tool provides a huge set of well tested command line commands which save hours of work time. All commands are extendable by a module API. 项目地址: https://gitcode.com/gh_mirrors/n9/n98-magerun2