n98 magerun cli ツールは、コマンド ラインから Magento を操作するための便利なツールをいくつか提供します。
最新リリース | |
開発ブランチ |
開発はdevelopブランチで行われます。
このソフトウェアは Magento 1 でのみ実行されます。
Magento 2 を使用している場合は、別の安定したバージョン (https://github.com/netz98/n98-magerun2) を使用してください。
ツールは複数の PHP バージョンに対して自動的にテストされます。現在、さまざまな Linux ディストリビューションおよび Mac OS X で実行されています。Microsoft Windows は完全にはサポートされていません (db:dump や install などの一部のコマンドは除外されています)。
このバージョンに対してツールをテストします。
ツールをインストールするには 3 つの方法があります。
最新の安定した N98-Magerun phar ファイルをファイル サーバーからダウンロードします。
wget https://files.magerun.net/n98-magerun.phar
または、Curl を使用したい場合は、次のようにします。
curl -O https://files.magerun.net/n98-magerun.phar
SHA256 チェックサムを Web サイト https://files.magerun.net/ のチェックサムと比較して、ダウンロードを検証します。
shasum -a256 n98-magerun.phar
Web サイトと同じチェックサムが表示されれば、ファイルは正常にダウンロードされました。
これで、phar ファイルを実行可能にすることができます。
chmod +x ./n98-magerun.phar
これで基本インストールが完了し、それを確認できます。
./n98-magerun.phar --version
コマンドは正常に実行され、次のように N98-Magerun のバージョン番号が表示されるはずです。
n98-magerun version 2.3.0 by valantic CEC
これでマゲルンのインストールが完了しました。システム全体にインストールするなど、インストールをさらに調整したり、オートコンプリートを有効にしたりできます。これらの機能やその他の機能の詳細については、以下をお読みください。
このコマンドをシステム全体で使用したい場合は、それを /usr/local/bin にコピーできます。
sudo cp ./n98-magerun.phar /usr/local/bin/
Debian / スホシン:
suhosin でコンパイルされた一部の Debian システムでは、phar 拡張機能をホワイトリストに追加する必要があります。
これを php.ini ファイルに追加します。
suhosin.executor.include.whitelist = " phar "
ファイル名が気に入らないのですか?
好きな名前に変更するだけです。あるいは、元のコマンド名が引き続き機能するようにエイリアスを作成することをお勧めします。これは、正規名が n98-magerun.phar であるため、magerun を使用するスクリプトを他のユーザーと交換する場合に役立ちます。ユーザーベースでの一般的なエイリアスの一部は、magerun または単に mr です。
Magento (またはその他の) プロジェクト内で Magerun を要求すると、ベンダーの bin フォルダーから実行できます。
composer require n98/magerun
# ...
./vendor/bin/n98-magerun --version
n98-magerun version 1.97.0 by netz98 new media GmbH
代替ソースのインストール:
https://github.com/netz98/n98-magerun/wiki/Install-from-source-with-Composer
まず、Homebrew をインストールする必要があります: http://brew.sh/
homebrew-php をタップしてインストールします: https://github.com/Homebrew/homebrew-php#installation
homebrew とタップがインストールされたら、それを使用してツールをインストールできます。
brew install n98-magerun
これで、次のツールを使用できるようになります。
$ n98-magerun {command}
バージョン 1.1.0 以降、pha ファイル内に自己更新スクリプトが含まれています。
$ n98-magerun.phar 自己更新
ファイルがシステム全体にインストールされている場合は、「sudo」を忘れないでください。
実際の動作をご覧ください: http://youtu.be/wMHpfKD9vjM
Magerun によるオートコンプリート用のファイルは、res/autocompletion フォルダー内にあります。以下では、2 つの特定のもの (Bash、Phpstorm) についてさらに詳しく説明します。さらに多くのファイル (Fish、Zsh など) もあります。
Bash 補完は事前に生成されており、すべてのコマンドとそれぞれのオプションはタブで利用できます。オプションを補完するには、2 つのダッシュ (「--」) を入力してからタブを入力します。
補完ファイルをインストールするには、自動補完のためにn98-magerun.phar.bashを bash compatdir フォルダーにコピーします。
私の Ubuntu システムでは、これは次のコマンドで実行できます。
# cp res/autocompletion/bash/n98-magerun.phar.bash /etc/bash_completion.d
具体的なフォルダーは pkg-config 経由で取得できます。
# pkg-config --variable=compatdir bash-completion
詳細情報は、bash-completions FAQ で入手できます: https://github.com/scop/bash-completion#faq
PHPStorm のコマンドライン ツールのオートコンプリート XML ファイルは、サブフォルダーres/autocompletion/phpstormに存在します。 n98_magerun.xml をphpstorm config フォルダーにコピーします。
Linux および Mac: ~/.WebIde80/config/componentVersions
設定メニューに XML コンテンツを追加することもできます。詳細な手順については、次のブログ投稿を参照してください: http://blog.jetbrains.com/webide/2012/10/integrating-composer-command-line-tool-with-phpstorm/
すべてのコマンドは、現在の Magento ルート ディレクトリの検出を試みます。複数の Magento インストールがある場合は、作業ディレクトリを優先インストールに変更する必要があります。
https://github.com/netz98/n98-magerun/wiki/Commands
次の方法で、使用可能なすべてのコマンドを一覧表示できます。
$ n98-magerun.phar リスト
.phar ファイルがシステム全体にインストールされていない場合は、PHP CLI インタープリターを使用してそれを呼び出すことができます。
php n98-magerun.pharリスト
グローバル設定パラメータ:
--ルートディレクトリ Magento のルート ディレクトリを強制します。自動検出はありません。 --skip-config カスタム構成をロードしないでください。 --skip-root-check n98-magerun が root として実行されているかどうかはチェックしません。 --開発者モード 開発者モードでMagentoをインスタンス化する
$ n98-magerun.phar open-browser [store]
電子メールアドレスによって基本的な顧客情報を読み込みます。
$ n98-magerun.phar customer:info [email] [website]
ショップ フロントエンドの新しい顧客/ユーザーを作成します。
$ n98-magerun.phar customer:create [email] [password] [firstname] [lastname] [website]
例:
$ n98-magerun.phar customer:create [email protected] password123 John Doe base
これにより、指定された ID/メールによる顧客が削除されるか、すべての顧客が削除されるか、または ID の範囲内のすべての顧客が削除されます。
$ n98-magerun.phar delete [-a | --all] [-f | --force] [-r | --range] [id]
例:
$ n98-magerun.phar customer:delete 1 # Will delete customer with Id 1
$ n98-magerun.phar customer:delete [email protected] # Will delete customer with that email
$ n98-magerun.phar customer:delete --all # Will delete all customers
$ n98-magerun.phar customer:delete --range # Will prompt for start and end Ids for batch deletion
ダミー顧客を生成します。カウントとロケールを指定できます。
$ n98-magerun.phar customer:create:dummy count locale [website]
サポートされているロケール:
- cs_CZ
- る_る
- bg_BG
- en_US
- それ_IT
- sr_RS
- sr_Cyrl_RS
- sr_Latn_RS
- pl_PL
- en_GB
- de_DE
- sk_SK
- fr_FR
- es_AR
- de_AT
顧客をリストアップします。出力は 1000 に制限されています (構成をオーバーライドすることで変更できます)。検索パラメータが指定されている場合、顧客はフィルタリングされます (名、姓、電子メールで検索)。
$ n98-magerun.phar customer:list [--format[ = " ... " ]] [search]
$ n98-magerun.phar customer:change-password [email] [password] [website]
$ n98-magerun.phar db:info [setting]
引数
設定 名前付き設定の値のみを出力します
mysqldump を使用して、構成された Magento データベースをダンプします。
引数
ファイル名 ダンプファイル名
オプション
--追加時間 ファイル名に時間を追加します (ファイル名が指定されていない場合のみ) —compression (-c) サポートされているアルゴリズムのいずれかを使用してダンプ ファイルを圧縮します。
--only-コマンド mysqldump コマンドのみを出力します。実行しないでください --print-only-filename 実行し、ダンプ ファイル名以外は出力されません。
--単一トランザクションなし 単一トランザクションは使用しないでください (ブロッキングなので推奨されません) —人間が読める形式 行ごとに列名を含む単一の挿入を使用します。
--stdout 標準出力にダンプする -strip ストリップするテーブル (それらのテーブルの構造のみをダンプ)
- --force (-f)
- すべてのオプションが定義されている場合はプロンプトを表示しない
$ n98-magerun.phar db:dump
mysqldump コマンドのみ:
$ n98-magerun.phar db:dump --only-command [filename]
または標準出力に直接:
$ n98-magerun.phar db:dump --stdout
圧縮を使用します (gzip cli ツールをインストールする必要があります)。
$ n98-magerun.phar db:dump --compression= " gzip "
データベースをダンプし、一部のテーブルを除外します。これは開発などに役立ちます。
ストリップする各テーブルをスペースで区切ります。 * や ? などのワイルドカードを使用できます。複数のテーブルを削除するには、テーブル名に含めます。さらに、@ で始まる事前定義されたテーブル グループを指定できます。例: "dataflow_batch_export un important_module_* @log"
$ n98-magerun.phar db:dump --strip= " @stripped "
利用可能なテーブルグループ:
拡張: https://github.com/netz98/n98-magerun/wiki/Stripped-Database-Dumps
実際の動作をご覧ください: http://youtu.be/ttjZHY6vThs
mysql cli クライアントを使用して SQL ファイルを現在構成されているデータベースにインポートします。
$ n98-magerun.phar db:dump
$ n98-magerun.phar db:import [--only-command] [filename]
解凍を使用します (gzip cli ツールをインストールする必要があります)。
$ n98-magerun.phar db:import --compression= " gzip " [filename]
「人間が読める」ダンプを最適化します。
$ n98-magerun.phar db:import --optimize [filename]
local.xml のデータベース設定を使用して MySQL コンソール クライアントを開きます。
$ n98-magerun.phar db:console [--no-auto-rehash]
--no-auto-rehash
synonym for calling * mysql * client with the -A parameter to skip hashing for object auto-completion.
現在構成されているデータベースを作成する
$ n98-magerun.phar db:create
local.xml で構成されたデータベースを削除します。
$ n98-magerun.phar db:drop [-f | --force]
現在構成されているデータベースに対して SQL クエリを実行します。 SQL を一重引用符または二重引用符で囲みます。
クエリが結果 (SELECT ステートメントなど) を生成すると、mysql cli ツールの出力が返されます。
--のみコマンド | mysql コマンドのみを出力します。実行しないでください |
$ n98-magerun.phar db:query [--only-command] [query]
Magento インスタンスの最も重要な MySQL 変数を確認してください。
$ n98-magerun.phar db:variables [--format[ = " ... " ]] [--rounding[ = " ... " ]] [--no-description] [search]
このコマンドは、現在のデータベースに関する重要なサーバー ステータス情報を出力するのに役立ちます。
$ n98-magerun.phar [--format[ = " ... " ]] [--rounding[ = " ... " ]] [--no-description] [search]
メディア フォルダーのコンテンツを含む ZIP アーカイブを作成します。
$ n98-magerun.phar media:dump [--strip] [filename]
ストリップ オプションが設定されている場合、次のフォルダーは除外されます。
新しいギフトカード プールを作成します
$ n98-magerun.phar giftcard:pool:generate
$ n98-magerun.phar giftcard:create [--website[ = " ... " ]] amount
Web サイト ID を指定することも、デフォルトの ID を使用することもできます。
$ n98-magerun.phar giftcard:info [--format[ = " ... " ]] code
$ n98-magerun.phar giftcard:remove code
$ n98-magerun.phar index:list [--format[ = " ... " ]]
インデクサーコードによるインデックス付け。コードはオプションです。コードを指定しない場合は、リストからインデクサーを選択できます。
$ n98-magerun.phar index:reindex [code]
1.75.0 以降、コードをカンマで区切ることで複数のインデクサーを実行できるようになりました。
つまり
$ n98-magerun.phar index:reindex catalog_product_attribute,tag_summary
引数としてインデックスが指定されていない場合は、メニューから最初と 3 番目のインデクサーを「1,3」などの「番号」で選択できます。
すべての Magento インデックスをループし、再インデックスをトリガーします。
$ n98-magerun.phar index:reindex:all
使用可能な Mview インデクサー、現在のバージョン、および変更ログ キューにある Mview インデクサーの数をリストします。
$ n98-magerun.phar index:list:mview [--format[ = " ... " ]]
Mview テーブル コードによるインデックス。これにより、すべてのロックが無視され、変更ログ インデクサーがトリガーされます。
$ n98-magerun.phar index:reindex:mview [table_code]
$ n98-magerun.phar local-config:generate
マージされた XML 設定を標準出力にダンプします。すべての XML を表示するのに役立ちます。
$ n98-magerun.phar [xpath]
カタログモジュールの構成:
$ n98-magerun.phar config:dump global/catalog
XML でのモジュール順序を参照してください。
$ n98-magerun.phar config:dump modules
出力をファイルに書き込みます。
$ n98-magerun.phar config:dump > extern_file.xml
$ n98-magerun.phar config:set [--scope[ = " ... " ]] [--scope-id[ = " ... " ]] [--encrypt] [--force] path value
- 範囲 | 構成値のスコープ (デフォルト: "default" | "default"、"websites"、"stores" を指定できます) |
--スコープID | 設定値のスコープID (デフォルト: "0") |
--暗号化 | local.xml の暗号キーを使用して構成値を暗号化する |
- 力 | Web サイトやストアに対する非標準のスコープ ID の作成を許可する |
$ n98-magerun.phar config:get [--scope = " ... " ] [--scope-id = " ... " ] [--decrypt] [--format[ = " ... " ]] [path]
- 範囲 | 設定値のスコープ (デフォルト、Web サイト、ストア) |
--スコープID | 設定値のスコープID |
--復号化 | local.xml の暗号化キーを使用して構成値を復号化します。 |
--更新スクリプト | |
更新スクリプト行として出力 | |
--magerun-script | |
config:set で使用するための出力 | |
- 形式 | json、xml、またはcsvとして出力 |
例:
$ n98-magerun.phar config:get web/ * --magerun-script
$ n98-magerun.phar config:delete [--scope[ = " ... " ]] [--scope-id[ = " ... " ]] [--all] [--force] path
- 範囲 | 構成範囲 (デフォルト、Web サイト、ストア) |
--スコープID | 設定値のスコープID |
- 全て | パスのすべてのエントリを削除します (--scope と --scope-id は無視します)。 |
- 力 | Web サイトとストアの非標準のスコープ ID の削除を許可する |
システム構成の説明を検索します。
$ n98-magerun.phar config:search text
$ n98-magerun.phar cache:list
期限切れのキャッシュ エントリを削除します。
1 つのキャッシュ タイプのみを削除したい場合は、次のようにします。
$ n98-magerun.phar cache:clean [--reinit] [--no-reinit] [ < code > ]
複数の種類のキャッシュを一度に消去したい場合は、次のようにします。
$ n98-magerun.phar cache:clean [--reinit] [--no-reinit] [ < code > ] [ < code > ] ...
すべてのキャッシュ エントリを削除したい場合は、cache:flush を使用します。
すべてのコードを表示するには、cache:list コマンドを実行します。
キャッシュ全体をフラッシュします。
$ n98-magerun.phar cache:flush [--reinit] [--no-reinit]
$ n98-magerun.phar cache:list [--format[ = " ... " ]]
$ n98-magerun.phar cache:disable [code]
コードが指定されていない場合、すべてのキャッシュ タイプが無効になります。すべてのコードを表示するには、cache:list コマンドを実行します。
$ n98-magerun.phar cache:enable [code]
コードが指定されていない場合は、すべてのキャッシュ タイプが有効になります。すべてのコードを表示するには、cache:list コマンドを実行します。
このコマンドを使用すると、キャッシュ内に何が保存されているかを調査できます。キャッシュ ID を含むテーブルを出力します。
$ cache:report [-t | --tags] [-m | --mtime] [--filter-id[ = " ... " ]] [--filter-tag[ = " ... " ]] [--fpc]
保存されたキャッシュ エントリを ID ごとに出力します。
$ cache:view [--unserialize] [--fpc] id
値がシリアル化されている場合は、--unserialize オプションを使用して出力を強制的に整形できます。
CMS ブロックの「is_active」を切り替えます
$ n98-magerun.phar cms:block:toggle [block_id]
「block_id」はエンティティIDまたは「識別子」です。
すべての CMS ブロックをリストする
$ n98-magerun.phar cms:block:list [--format[ = " ... " ]]
デモストアのお知らせを切り替えます
$ n98-magerun.phar design:demo-notice [store_code]
$ n98-magerun.phar admin:user:list [--format[ = " ... " ]]
$ n98-magerun.phar admin:user:create [username] [email] [password] [firstname] [lastname] [role]
$ n98-magerun.phar admin:user:change-password [username] [password]
$ n98-magerun.phar admin:user:delete [email | username] [-f]
ID には電子メールまたはユーザー名を指定できます。このコマンドは、最初にユーザー名でユーザーを検索しようとし、見つからない場合は電子メールでユーザーを検索しようとします。 ID を省略した場合は、ID の入力を求めるプロンプトが表示されます。強制パラメータ「-f」を省略すると、確認を求めるプロンプトが表示されます。
$ n98-magerun.phar admin:user:change-status [--activate] [--deactivate] [email | username]
バックエンド ユーザーのアクティブ ステータスを切り替えます。 ID には電子メールまたはユーザー名を指定できます。このコマンドは、最初にユーザー名でユーザーを検索しようとし、見つからない場合は電子メールでユーザーを検索しようとします。 ID を省略した場合は、ID の入力を求めるプロンプトが表示されます。
$ n98-magerun.phar admin:user:lock [username] [lifetime]
[ライフタイム]で指定された日数の間、管理者ユーザーをロックします。指定しない場合、有効期間はデフォルトで 31 日になります。
$ n98-magerun.phar admin:user:lockdown [lifetime] [--dry-run]
[ライフタイム]で指定された日数の間、システム内のすべての管理者ユーザーをロックします。上記と同様、指定しない場合はデフォルトで 31 日になります。
慎重に使用してください。最初に --dry-run オプションを使用してテストします。
$ n98-magerun.phar admin:user:unlock [username]
管理者のパスワード ロックを解除します (すべての管理者のロックを解除するには空白のままにします)。
管理者への通知を切り替えます。
$ n98-magerun.phar admin:notifications
オプションが指定されていない場合は、呼び出しごとにモードが切り替わります。
$ n98-magerun.phar sys:maintenance [--on] [--off]
エディションやバージョン、設定されたキャッシュ バックエンドなどの情報を提供します。
$ n98-magerun.phar sys:info [key]
バージョンなどの値を 1 つだけ出力します。
$ n98-magerun.phar sys:info version
すべてのストアビューをリストします。
$ n98-magerun.phar sys:store:list [--format[ = " ... " ]]
各ストアのベース URL をリストします。
$ n98-magerun.phar sys:store:config:base-url:list [--format[ = " ... " ]]
すべての Web サイトをリストします。
$ n98-magerun.phar sys:website:list [--format[ = " ... " ]]
config.xml ファイルで定義されているすべての cron ジョブをリストします。
$ n98-magerun.phar sys:cron:list [--format[ = " ... " ]]
コードによって cron ジョブを実行します。
$ n98-magerun.phar sys:cron:run [--schedule] [job]
ジョブ引数が渡されない場合は、リストからジョブを選択できます。実際の動作をご覧ください: http://www.youtube.com/watch?v=QkzkLgrfNaM オプションのスケジュールが存在する場合、cron は起動されませんが、magento crontab でただちにスケジュールされるだけです。
最後に実行された cron ジョブとステータス。
$ n98-magerun.phar sys:cron:history [--format[ = " ... " ]] [--timezone[ = " ... " ]]
$ n98-magerun.phar sys:url:list [--add-categories] [--add-products] [--add-cmspages] [--add-all] [stores] [linetemplate]
例:
$ n98-magerun.phar sys:url:list --add-products 4
$ n98-magerun.phar sys:url:list --add-all 4,5 ' {host},{path} ' > urls.csv
すべてのセットアップ スクリプトを実行します (フロントエンドを呼び出す必要はありません)。このコマンドは、メンテナンス モードを有効にしてシステムを更新する場合に役立ちます。
$ n98-magerun.phar sys:setup:run
セットアップ スクリプトを段階的に実行します。 (フロントエンドを呼び出す必要はありません)。このコマンドは、セットアップ リソース システムの透過性を高め、PHP エラーによって無効なデータベース状態が作成される可能性を減らすために、新しいセットアップ スクリプトを個別に実行します。
$ n98-magerun.phar sys:setup:incremental [--stop-on-error]
モジュールのバージョンと core_resource テーブルに保存されているセットアップのバージョンを比較し、バージョンの不一致を表示します。
$ n98-magerun.phar sys:setup:compare-versions [--ignore-data] [--errors-only] [--log-junit = " ... " ] [--format[ = " ... " ]]
1 つまたはすべてのモジュール リソース セットアップのバージョンを変更します。このコマンドは、デバッグが原因でアップグレード スクリプトを再度実行する場合に便利です。あるいは、データベース内の行を手動で変更する必要があります。
$ n98-magerun.phar sys:setup:change-version module version [setup]
セットアップ引数のデフォルトは、指定されたモジュールの「すべてのリソース」です。
1 つまたはすべてのモジュール リソース セットアップのエントリを削除します。このコマンドは、デバッグが原因でインストール スクリプトを再度実行する場合に便利です。あるいは、データベースから行を手動で削除する必要があります。
$ n98-magerun.phar sys:setup:remove module [setup]
セットアップ引数のデフォルトは、指定されたモジュールの「すべてのリソース」です。
$ n98-magerun.phar sys:check
CMS バナーの非表示/表示
$ n98-magerun.phar cms:banner:toggle < banner_id >
ページ ID とリビジョンごとにページを公開します。
$ n98-magerun.phar cms:page:publish < page_id > < revision_id >
cron ジョブによってページを自動的に公開する場合に便利です。
初期化された Magento Admin-Store で PHP インタラクティブ シェルを開きます。
$ n98-magerun.phar dev:console
実際の動作をご覧ください: http://www.youtube.com/watch?v=zAWpRpawTGc
このコマンドは、PHP 5.4 ユーザーのみが使用できます。
ストアの CSS マージ設定を切り替えます
$ n98-magerun.phar dev:merge-css [store_code]
ストアの JS マージ設定を切り替えます
$ n98-magerun.phar dev:merge-js [store_code]
ストアのデバッグ テンプレート ヒント設定を切り替えます
$ n98-magerun.phar dev:template-hints [store_code]
デバッグ テンプレートのヒントによるストアの設定のブロックの切り替え
$ n98-magerun.phar dev:template-hints-blocks [store_code]
ショップ フロントエンドの設定を切り替えます。
$ n98-magerun.phar dev:translate:shop [store_code]
管理エリアの切り替え:
$ n98-magerun.phar dev:translate:admin
保存されているデータベース翻訳データをファイルにエクスポートします。
$ n98-magerun.phar dev:translate:export [locale] [filename]
ストアをデバッグするためのプロファイラーを切り替えます。
$ n98-magerun.phar dev:profiler [--on] [--off] [--global] [store]
トランザクション電子メール テンプレートの使用レポートを表示します。
$ n98-magerun.phar dev:email-template:usage --format[ = FORMAT]
ストアの system.log および例外.log をアクティブ化/非アクティブ化します。
$ n98-magerun.phar dev:log [--on] [--off] [--global] [store]
ログ ファイルのサイズを表示します。
$ n98-magerun.phar dev:log:size [--human] [log_filename]
lib/Varien/Db/Adapter/Pdo/Mysql.php 経由で MySQL クエリのログをアクティブ化/非アクティブ化します。
$ n98-magerun.phar dev:log:db [--on] [--off]
属性のスクリプトを生成します。
$ n98-magerun.phar dev:setup:script:attribute entityType attributeCode
つまり
$ n98-magerun.phar dev:setup:script:attribute catalog_product color
現在、 catalog_productエンティティ タイプのみがサポートされています。
すべての EAV 属性をリストします。
$ n98-magerun.phar eav:attribute:list [--filter-type[ = " ... " ]] [--add-source] [--add-backend] [--format[ = " ... " ]]
特定の属性のデータを表示します。
$ n98-magerun.phar eav:attribute:view [--format[ = " ... " ]] entityType attributeCode
属性を削除します。
$ n98-magerun.phar eav:attribute:remove entityType attributeCode
同じタイプの複数の属性を一度に削除することもできます。
$ n98-magerun.phar eav:attribute:remove entityType attributeCode1 attributeCode2 ... attributeCode10
PhpStorm コード補完-> メタ ファイルの生成。
$ n98-magerun.phar dev:ide:phpstorm:meta [--meta-version = (old | 2016.2+)] [--stdout]
PhpStormオートコンプリート用のメタデータファイルを生成します(デフォルトバージョン:2016.2+)
var/reports フォルダー内のレポートの数を出力します。
$ n98-magerun.phar dev:report:count
指定された型とグループ化されたクラス名をクラス名に解決します。これは、書き換えのデバッグに役立ちます。
解決されたクラスが存在しない場合は、情報メッセージが表示されます。
$ n98-magerun.phar dev:class:lookup < block | model | helper > < name >
例:
$ n98-magerun.phar dev:class:lookup model catalog/product
ストアビューのシンボリックリンクの使用を許可します。
$ n98-magerun.phar dev:symlinks [--on] [--off] [--global] [store_code]
グローバル スコープは、store_code パラメータを許可しないことで設定できます。
$ n98-magerun.phar dev:symlinks
空のモジュールを作成し、現在の Magento ショップに登録します。
$ n98-magerun.phar dev:module:create [--add-controllers] [--add-blocks] [--add-helpers] [--add-models] [--add-setup] [--add-all] [--modman] [--add-readme] [--add-composer] [--author-name[ = " ... " ]] [--author-email[ = " ... " ]] [--description[ = " ... " ]] vendorNamespace moduleName [codePool]
コードプールのデフォルトはローカルです。
例:
$ n98-magerun.phar dev:module:create MyVendor MyModule
.modman フォルダー内でこのコマンドを実行します。
$ n98-magerun.phar dev:code:model:method [modelName]
app/etc/modules/*.xml 内のモジュールを名前または codePool で有効または無効にします。
$ n98-magerun.phar dev:module:enable [--codepool = " ... " ] moduleName
$ n98-magerun.phar dev:module:disable [--codepool = " ... " ] moduleName
例:
$ n98-magerun.phar dev:module:disable MyVendor_MyModule
$ n98-magerun.phar dev:module:disable --codepool= " community "
ヒント
--codepool オプションが指定されている場合、コードプール内のすべてのモジュールが影響を受けます。
インストールされているすべてのモジュールをコードプールとバージョンとともにリストします。
$ n98-magerun.phar dev:module:list [--codepool[ = " ... " ]] [--status[ = " ... " ]] [--vendor = [ = " ... " ]] [--format[ = " ... " ]]
登録されているすべてのクラス リライトをリストします。
$ n98-magerun.phar dev:module:rewrite:list [--format[ = " ... " ]]
重複したリライトをすべてリストし、どのクラスが Magento によってロードされたかを示します。このコマンドは、モジュールの依存関係の順序でクラスの継承をチェックします。
$ n98-magerun.phar dev:module:rewrite:conflicts [--log-junit = " ... " ]
指定されたモジュールが依存するモジュールのリストを表示します
$ n98-magerun.phar dev:module:dependencies:on [-a | --all] [--format[ = " ... " ]] moduleName
モジュールに依存するモジュールのリストを表示
$ n98-magerun.phar dev:module:dependencies:from [-a | --all] [--format[ = " ... " ]] moduleName
登録されているすべてのオブザーバーをタイプ別にリストします。
$ n98-magerun.phar dev:module:observer:list [type]
タイプは「adminhtml」、「global」、「frontend」のいずれかです。
すべてのフロントエンドテーマをリストします
$ n98-magerun.phar dev:theme:list [--format[ = " ... " ]]
2 つのテーマ間で重複するファイル (テンプレート、レイアウト、ロケールなど) を検索します。
$ n98-magerun.phar dev:theme:duplicates [--log-junit = " ... " ] theme [originalTheme]
例:
$ n98-magerun.phar dev:theme:duplicates default/default
$ n98-magerun.phar category:create:dummy
すべてのデフォルトのバニラ マジェントまたはカスタム値を使用してダミー カテゴリを作成します。
インタラクティブモード、シェル引数経由、または混合モード。
引数 | 説明 | 受け入れられる値 |
ストアID | カテゴリを作成するストアの ID (デフォルト: 1) | 整数のみ |
カテゴリ番号 | 作成するカテゴリの数 (デフォルト: 1) | 整数のみ |
子カテゴリ番号 | 作成される各カテゴリの子の数 (デフォルト: 0 - 0 ~ 5 のランダムな場合は「-1」を使用します) | 整数のみ、または 0 ~ 5 の乱数の場合は -1 |
カテゴリ名の接頭語 | カテゴリ名のプレフィックス (デフォルト: 「My Awesome カテゴリ」) | どれでも |
$ n98-magerun.phar eav:attribute:create-dummy-values
ダミー属性値の作成 (ドロップダウン属性のみ)
インタラクティブモード、シェル引数経由、または混合モード。
引数 | 説明 | 受け入れられる値 |
ロケール | en_US などの ISO 標準のロケール値 | 文字列のみ |
属性ID | 値を追加する属性ID | 整数のみ |
値の種類 | 作成する値のタイプ (デフォルトは int) | int`<br />`string`<br />`color`<br />`size`<br />`デザイナー |
値-数値 | 作成する値の数 (デフォルトは 1) | 整数のみ |
オプションの検索文字列を使用して、接続拡張機能をリストおよび検索します。
$ n98-magerun.phar extension:list [--format[ = " ... " ]] < search >
パッケージ キーによって接続拡張機能をインストールします。
$ n98-magerun.phar extension:install < package_key >
パッケージが見つからなかった場合は、代替品の検索が行われます。代替手段が見つかった場合は、インストールするパッケージを選択できます。
パッケージ キーごとに接続拡張機能をダウンロードします。
$ n98-magerun.phar extension:download < search >
パッケージ キーによって接続拡張機能をアップグレードします。
$ n98-magerun.phar extension:upgrade < search >
バージョン 1.1.0 以降、次のことを行う Magento インストーラーが提供されています。
対話型インストーラー:
$ n98-magerun.phar install
無人インストール:
$ n98-magerun.phar install [--magentoVersion[ = " ... " ]] [--magentoVersionByName[ = " ... " ]] [--installationFolder[ = " ... " ]] [--dbHost[ = " ... " ]] [--dbUser[ = " ... " ]] [--dbPass[ = " ... " ]] [--dbName[ = " ... " ]] [--installSampleData[ = " ... " ]] [--useDefaultConfigParams[ = " ... " ]] [--baseUrl[ = " ... " ]] [--replaceHtaccessFile[ = " ... " ]]
Magento CE 1.7.0.2 の無人インストールの例:
$ n98-magerun.phar install --dbHost= " localhost " --dbUser= " mydbuser " --dbPass= " mysecret " --dbName= " magentodb " --installSampleData=yes --useDefaultConfigParams=yes --magentoVersionByName= " magento-ce-1.7.0.2 " --installationFolder= " magento " --baseUrl= " http://magento.localdomain/ "
さらに、 --noDownload オプションを使用すると、指定されたデータベースの --installationFolder に既に保存されている Magento 作業コピーをインストールできます。
実際の動作をご覧ください: http://youtu.be/WU-CbJ86eQc
Magento をアンインストールします: データベースを削除し、インストール フォルダーを再帰的に削除します。
$ n98-magerun.phar uninstall [-f | --force] [--installationFolder[ = " ... " ]]
注意してください: これにより、インストールからすべてのデータが削除されます。
--installationFolder は必須であり、入力しない場合は入力を求めるメッセージが表示されます。これは、Magento のルートではなく、プロジェクトのルートである必要があります。たとえば、プロジェクトのルートが /var/www/site で、Magento src が /var/www/site/htdocs にある場合、コマンドに /var/www/site を渡す必要があります。または、現在その特定の場所にいる場合は、/var/www/site をコマンドに渡す必要があります。ディレクトリには「.」を渡すだけです。例えば:
$ cd /var/www/site
$ n98-magerun.phar uninstall --installationFolder " . " -f
-f を省略すると、確認を求めるメッセージが表示されます。
すべての n98-magerun コマンドにオートコンプリートが必要な場合は、「shell コマンド」から開始できます。
$ n98-magerun.phar shell
スクリプト ファイルから複数のコマンドを実行します。
$ n98-magerun.phar script [-d | --define[ = " ... " ]] [--stop-on-error] [filename]
例:
# 複数の設定を設定する config:set "web/cookie/cookie_domain" example.com # 「n」を使用して複数行の値を設定します config:set "general/店舗情報/アドレス" "1 行目n2 行目n3 行目" #これはコメントです キャッシュ:フラッシュ
オプションで、UNIX パイプを使用できます。
$ echo " cache:flush " | n98-magerun-dev script
$ n98-magerun.phar script < filename
実行可能なスクリプトを作成することも可能です。
ファイル test.magerun を作成し、実行可能にします (chmod +x test.magerun)。
#! /usr/bin/env n98-magerun.phar script
config:set " web/cookie/cookie_domain " example.com
cache:flush
# Run a shell script with "!" as first char
! ls -l
# Register your own variable (only key = value currently supported)
${my.var} =bar
# Let magerun ask for variable value - add a question mark
${my.var} = ?
! echo ${my.var}
# Use resolved variables from n98-magerun in shell commands
! ls -l ${magento.root} /code/local
事前定義された変数:
「--define (-d)」オプションを使用して変数をスクリプトに渡すことができます。
例:
$ n98-magerun.phar script -d foo=bar filename
# This will register the variable ${foo} with value bar.
複数のオプションを渡すことで、複数の値を定義できます。
スクリプトをリポジトリに整理できます。スクリプトをフォルダー/usr/local/share/n98-magerun/scriptsまたはフォルダー<HOME>/.n98-magerun/scriptsのホーム ディレクトリに配置するだけです。
スクリプトには、ファイル拡張子.magerunが必要です。
その後、 script:repo:listコマンドを使用してすべてのスクリプトを一覧表示できます。スクリプトの最初の行には、説明として表示されるコメント (先頭に # が付いている行) を含めることができます。
$ n98-magerun.phar script:repo:list [--format[ = " ... " ]]
リポジトリからスクリプトを実行したい場合は、script:repo:runコマンドで実行できます。
$ n98-magerun.phar script:repo:run [-d | --define[ = " ... " ]] [--stop-on-error] [script]
スクリプト引数はオプションです。何も指定しない場合は、リストから 1 つを選択できます。
https://github.com/netz98/n98-magerun/wiki/Add-custom-commands
yaml 構成ファイル~/.n98-magerun.yamlを作成します。これで上書きを定義できるようになりました。元の構成ファイルは、ソース ルート フォルダーにあるconfig.yamlです。
IE のデフォルト通貨と管理者ユーザーの変更:
commands :
N98MagentoCommandInstallerInstallCommand :
installation :
defaults :
currency : USD
admin_username : myadmin
admin_firstname : Firstname
admin_lastname : Lastname
admin_password : mydefaultSecret
admin_email : [email protected]
yaml 構成ファイル~/.n98-magerun.yamlを作成します。これで上書きを定義できるようになりました。元の構成ファイルは、ソース ルート フォルダーにあるconfig.yamlです。
リポジトリを追加します。構成ファイル内のキーは、composer パッケージの構造に従います。
例:
コマンド: N98MagentoCommandInstallerInstallCommand: マジェントパッケージ: - 名前: my-magento-git-repository バージョン: 1.xxx ソース: URL: git://myserver/myrepo.git タイプ: git 参照: 1.xxx 余分な: サンプルデータ: サンプルデータ-1.6.1.0 - 名前: my-zipped-magento バージョン: 1.7.0.0 距離: URL: http://www.myserver.example.com/magento-1.7.0.0.tar.gz タイプ: タール 余分な: サンプルデータ: サンプルデータ-1.6.1.0