コマンドラインインターフェース / コマンド

既にいろいろなことをするために、コマンドラインインターフェースの使い方は学びました。この章は全ての利用可能なコマンドを説明します。

コマンドラインからヘルプを得るためには、composerまたはcomposer listを実行して全てのコマンドの完全な一覧を見ることができます。更に--helpをそれらのコマンドと組み合わせれば、より多くの情報を得られます。

Composerはsymfony/consoleを使っているため、曖昧でなければ短い名前でコマンドを呼び出せます。

php composer.phar dump

上ではcomposer dump-autoloadを呼び出します。

Bashの補完

Bashの補完をインストールするには、composer completion bash > completion.bashと走らせられます。現在のディレクトリにcompletion.bashファイルを作ります。

それからsource completion.bashを実行すれば現在の端末のセッションで有効になります。

completion.bashを/etc/bash_completion.d/composerに移動しつつ改名すれば、新しい端末で自動的に読み込まれるようにできます。

大域オプション

以下のオプションは全てのコマンドで利用できます。

–verbose (-v): メッセージの冗長さを増やす。
–help (-h): ヘルプ情報を表示する。
–quiet (-q): メッセージを一切出力しない。
–no-interaction (-n): 対話的な質問の問い合わせを一切行わない。
–no-plugins: プラグインを無効にする。
–no-scripts: composer.jsonで定義されているスクリプトの実行を飛ばす。
–no-cache: キャッシュディレクトリの使用を無効にする。 COMPOSER_CACHE_DIR環境変数を/dev/null（WindowsではNUL）に設定することと同じです。
–working-dir (-d): 指定すると、与えられたディレクトリを作業ディレクトリに使う。
–profile: 時間とメモリ使用量の情報を表示する。
–ansi: ANSI出力を強制する。
–no-ansi: ANSI出力を行わない。
–version (-V): 本アプリケーションのバージョンを表示する。

init

ライブラリの章でcomposer.jsonを手作りする方法を見ました。こうしたことをするのにinitコマンドというのもあります。

このコマンドを実行すると、賢明な既定値を使いながら、対話的な問答を経てフィールドが埋められていきます。

php composer.phar init

オプション

–name: パッケージの名前。
–description: パッケージの説明。
–author: パッケージの作者名。
–type: パッケージの種類。
–homepage: パッケージのホームページ。
–require: バージョン制約付きの必要なパッケージ。書式はfoo/bar:1.0.0のようになります。
–require-dev: 開発のための要件です。–requireを参照。
–stability (-s): minimum-stabilityフィールド用の値。
–license (-l): パッケージの利用許諾。
–repository: 1つ（かそれ以上）の個別のリポジトリを与えます。これらのリポジトリは生成されるcomposer.jsonに収められ、要件の一覧を提案する際の自動補完に使われます。全てのリポジトリはcomposerリポジトリを指すHTTPのURLないしrepositoriesキーが受け付けるものと同様のJSON文字列の何れかを取ります。
–autoload (-a): composer.jsonへのPSR-4自動読み込みの対応付けを加えます。自動的にパッケージの名前空間を与えられたディレクトリに対応付けます（src/のような相対パスを想定しています）。 PSR-4自動読み込みも参照してください。

install / i

installコマンドは現在のディレクトリからcomposer.jsonファイルを読み込み、依存物を解決し、vendor配下にインストールします。

php composer.phar install

現在のディレクトリにcomposer.lockファイルが存在する場合は、依存物を解決する代わりに、そこから厳密なバージョンを使います。ライブラリを使う全ての利用者が同じバージョンの依存物を持つことを保証します。

composer.lockファイルがない場合、composerは依存物を解決した後で作成します。

オプション

–prefer-install: パッケージをダウンロードする方法はsourceとdistの2つあります。 Composerはdistを既定で使います。 --prefer-install=source（または--prefer-source）を渡すと、Composerは、もしあればsourceからインストールします。プロジェクトへのバグ修正をして、依存関係のローカルgitクローンを直接取得したい場合に便利です。 Composerがパッケージの開発版用のsourceを自動的に使う、以前の挙動にしたければ、--prefer-install=autoを使ってください。 config.preferred-installも参照してください。このフラグを渡すと、設定値より優先されます。
–source-fallback / –no-source-fallback: Override the config.source-fallback setting. When disabled, Composer will not fall back to an alternative download source (e.g., from dist to source or vice versa) if the preferred one fails. Also see COMPOSER_SOURCE_FALLBACK.
–dry-run: 実際にはパッケージをインストールすることなくインストールの過程を進めたいときは--dry-runを使うことができます。インストールを模擬して何が起こるのかを示します。
–download-only: ダウンロードするのみで、パッケージをインストールしません。
–dev: require-devに挙げられたパッケージをインストールします（既定の挙動です）。
–no-dev: require-devに挙げられたパッケージのインストールを飛ばします。自動読み込み器の生成でautoload-dev規則を読み飛ばします。 COMPOSER_NO_DEVも参照してください。
–no-autoloader: 自動読み込み器の生成を飛ばします。
–no-progress: 進捗表示を除きます。バックスペース文字を扱わない端末やスクリプトではこの表示があることで散らかってしまうからです。
–audit: インストールが完了した後に監査を走らせます。
–audit-format: 監査の出力形式です。 “table”、“plain”、“json”、または“summary“（既定）のどれかでなければなりません。
–no-security-blocking: 非推奨であり、--no-blockingを代用してください。セキュリティ勧告があったり放棄されたりしているパッケージのインストールを許容します。 COMPOSER_NO_SECURITY_BLOCKINGも参照。
–no-blocking: このコマンドの間はすべてのポリシーによる遮断を無効にします。 COMPOSER_NO_BLOCKINGも参照。
–optimize-autoloader (-o): PSR-0の自動読み込みをクラス対応表に変換して自動読み込みを高速にします。実運用では特にお勧めしますが、走らせるのに少し時間が掛かることがあるので、現在は既定ではされません。
–classmap-authoritative (-a): クラス対応表からクラスのみを自動読み込みします。暗黙裡に--optimize-autoloaderを有効にします。
–strict-psr-autoloader: 現在のプロジェクトで（依存関係は除き）PSR-4またはPSR-0の対応付けのエラーが存在するなら失敗の終了コード (6) を返します。動作には--optimize-autoloaderが必要です。
–apcu-autoloader: APCuを使って、クラスの有無をキャッシュします。
–apcu-autoloader-prefix: APCu自動読み込み器のキャッシュ用に独自の接頭辞を使います。暗黙裡に--apcu-autoloaderを有効にします。
–ignore-platform-reqs: 全てのプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、ローカルマシンがたとえこれらを満たしていなくてもインストールを強行します。 platform設定オプションも参照してください。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、ローカルマシンがたとえこれらを満たしていなくてもインストールを強行します。ワイルドカードを使って複数の要件を無視できます。 +を後ろに付けることで要件の上限値だけを無視できます。例えばパッケージがphp: ^7を要求しているとき、オプション--ignore-platform-req=php+はPHP8でのインストールを許しますが、PHP 5.6でのインストールについては失敗します。

update / u / upgrade

依存関係の最新版を取得してcomposer.lockファイルを更新する上ではupdateコマンドを使うと良いでしょう。このコマンドにはupgradeの別名が付けられていますが、apt-getや類するパッケージ管理を連想したときにupgradeがすることと同じだからです。

php composer.phar update

こうするとプロジェクトの全ての依存関係を解決し、厳密なバージョンをcomposer.lockに書き込みます。

全てではなく、2、3のパッケージのみを更新したい場合は、以下のように列挙できます。

php composer.phar update vendor/package vendor/package2

ワイルドカードを使って複数のパッケージを一挙に更新することもできます。

php composer.phar update "vendor/*"

composer.jsonを変えることなくパッケージを指定のバージョンに巻き戻したいときは、--withを使うことができます。このオプションには自分で選んだバージョン制約を与えます。

php composer.phar update --with vendor/package:2.0.1

なお上記では全てのパッケージが更新されます。 --withを使って自分で選んだ制約を与えたパッケージのみを更新するには、--withを省き、代わりに部分的な更新構文を持つ制約を使ってください。

php composer.phar update vendor/package:2.0.1 vendor/package2:3.0.*

補足： composer.jsonでも要求されているパッケージについては、自分で選んだ制約は既存の制約の部分集合でなければなりません。 composer.jsonでの制約は適用されたままであり、これらの一時的な制約の更新では変更されません。

オプション

–prefer-install: パッケージをダウンロードする方法はsourceとdistの2つあります。 Composerはdistを既定で使います。 --prefer-install=source（または--prefer-source）を渡すと、Composerは、もしあればsourceからインストールします。プロジェクトへのバグ修正をして、依存関係のローカルgitクローンを直接取得したい場合に便利です。 Composerがパッケージの開発版用のsourceを自動的に使う、以前の挙動にしたければ、--prefer-install=autoを使ってください。 config.preferred-installも参照してください。このフラグを渡すと、設定値より優先されます。
–source-fallback / –no-source-fallback: Override the config.source-fallback setting. When disabled, Composer will not fall back to an alternative download source (e.g., from dist to source or vice versa) if the preferred one fails. Also see COMPOSER_SOURCE_FALLBACK.
–dry-run: 実際には何もせず、コマンドを模擬します。
–dev: require-devに挙げられたパッケージをインストールします（既定の挙動です）。
–no-dev: require-devに挙げられたパッケージのインストールを飛ばします。自動読み込み器の生成でautoload-dev規則を読み飛ばします。 COMPOSER_NO_DEVも参照してください。
–no-install: composer.lockを更新した後のインストール過程を走らせません。
–no-audit: composer.lockを更新した後の監査過程を走らせません。COMPOSER_NO_AUDITも参照してください。
–audit-format: 監査の出力形式です。 “table”、“plain”、“json”、または“summary“（既定）のどれかでなければなりません。
–no-security-blocking: 非推奨であり、--no-blockingを代用してください。セキュリティ勧告があったり放棄されたりしているパッケージのインストールを許容します。 COMPOSER_NO_SECURITY_BLOCKINGも参照。
–no-blocking: このコマンドの間はすべてのポリシーによる遮断を無効にします。 COMPOSER_NO_BLOCKINGも参照。
–lock: パッケージのバージョンを更新せず、固定ファイルが期限切れであることについての警告を抑えるために固定ファイルを上書きします。ミラーやURLといったパッケージのメタデータが変更されていれば更新します。
–with: 一時的に追加するバージョン制約です。例えばfoo/bar:1.0.0やfoo/bar=1.0.0です。
–no-autoloader: 自動読み込み器の生成を飛ばします。
–no-progress: 進捗表示を除きます。バックスペース文字を扱わない端末やスクリプトではこの表示があることで散らかってしまうからです。
–with-dependencies (-w): 引数リスト中のパッケージの依存関係も更新します。ただし根幹要件は除きます。 COMPOSER_WITH_DEPENDENCIES=1 環境変数で設定することもできます。
–with-all-dependencies (-W): 引数リスト中のパッケージの依存関係も更新します。根幹要件を含みます。 COMPOSER_WITH_ALL_DEPENDENCIES=1 環境変数でも設定できます。
–optimize-autoloader (-o): PSR-0自動読み込みをクラスマップに変換して、より高速な自動読み込み器を取得します。特に実運用で推奨されますが、走らせるのに少し時間が掛かるため、現時点では既定では有効になっていません。
–classmap-authoritative (-a): クラス対応表からクラスのみを自動読み込みします。暗黙裡に--optimize-autoloaderを有効にします。
–strict-psr-autoloader: 現在のプロジェクトで（依存関係は除き）PSR-4またはPSR-0の対応付けのエラーが存在するなら失敗の終了コード (6) を返します。動作には--optimize-autoloaderが必要です。
–apcu-autoloader: APCuを使って、クラスの有無をキャッシュします。
–apcu-autoloader-prefix: APCu自動読み込み器のキャッシュ用に独自の接頭辞を使います。暗黙裡に--apcu-autoloaderを有効にします。
–ignore-platform-reqs: 全てのプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、ローカルマシンがたとえこれらを満たしていなくてもインストールを強行します。 platform設定オプションも参照してください。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、ローカルマシンがたとえこれらを満たしていなくてもインストールを強行します。ワイルドカードを使って複数の要件を無視できます。 +を後ろに付けることで要件の上限値だけを無視できます。例えばパッケージがphp: ^7を要求しているとき、オプション--ignore-platform-req=php+はPHP8でのインストールを許しますが、PHP 5.6でのインストールについては失敗します。
–prefer-stable: 依存関係の安定板を選ぶようにします。COMPOSER_PREFER_STABLE=1環境変数を介しても設定できます。
–prefer-lowest: 依存関係の最も低いバージョンを選ぶようにします。最小バージョン要件を試す際に便利で、一般的には--prefer-stableと共に使われます。COMPOSER_PREFER_LOWERST=1環境変数を介しても設定できます。
–minimal-changes (-m): 依存関係に関して絶対に必須の変更のみ行います。パッケージが現在固定されているバージョンに留めておけないときは更新されます。部分更新については、許可一覧にあるパッケージは常に完全に更新されます。 COMPOSER_MINIMAL_CHANGES=1環境変数でも設定できます。
–patch-only: 現在インストールされている依存関係について、パッチバージョンの更新のみ許可します。
–interactive: 自動補完付きの対話的なインターフェースで、更新するパッケージを選択します。
–root-reqs: 更新を一次依存関係に制限します。
–bump-after-update: 更新後にbumpを走らせます。 devやno-devを設定すると、それぞれの依存関係のみのバージョンを上げます。

引数として単語mirrors、lock、nothingからどれか1つを指定すると、オプション--lockを指定することと同じ効果があります。例えばcomposer update mirrorsはcomposer update --lockと全く同じです。

require / r

requireコマンドはcomposer.jsonファイルに現在のディレクトリから新しいパッケージを追加します。1つもファイルが存在しなければ必要に応じて作られます。

パッケージを指定しない場合、Composerはパッケージを探すためにプロンプトを出し、要件にするものに照合する一覧を提供します。

php composer.phar require

要件を加えたり変えたりした後に、変更された要件がインストールされたり更新されたりします。

対話的に要件を選びたくなければコマンドに渡すこともできます。

php composer.phar require "vendor/package:2.*" vendor/package2:dev-master

バージョン制約を指定しなければ、composerは利用できるパッケージのバージョンに基づいて相応しいものを選びます。

php composer.phar require vendor/package vendor/package2

すぐには新しい依存関係をインストールしたくない場合は–no-update付きで呼べます。

オプション

–dev: パッケージをrequire-devに追加します。
–dry-run: 実際には何もせず、コマンドを模擬します。
–prefer-install: パッケージをダウンロードする方法はsourceとdistの2つあります。 Composerはdistを既定で使います。 --prefer-install=source（または--prefer-source）を渡すと、Composerは、もしあればsourceからインストールします。プロジェクトへのバグ修正をして、依存関係のローカルgitクローンを直接取得したい場合に便利です。 Composerがパッケージの開発版用のsourceを自動的に使う、以前の挙動にしたければ、--prefer-install=autoを使ってください。 config.preferred-installも参照してください。このフラグを渡すと、設定値より優先されます。
–source-fallback / –no-source-fallback: Override the config.source-fallback setting. When disabled, Composer will not fall back to an alternative download source (e.g., from dist to source or vice versa) if the preferred one fails. Also see COMPOSER_SOURCE_FALLBACK.
–no-progress: 進捗表示を除きます。バックスペース文字を扱わない端末やスクリプトではこの表示があることで散らかってしまうからです。
–no-update: 依存関係の自動的な更新を無効にします（–no-installを暗示します）。
–no-install: composer.lockを更新した後のインストール過程を走らせません。
–no-audit: composer.lockを更新した後の監査過程を走らせません。COMPOSER_NO_AUDITも参照してください。
–audit-format: 監査の出力形式です。 “table”、“plain”、“json”、または“summary“（既定）のどれかでなければなりません。
–no-security-blocking: 非推奨であり、--no-blockingを代用してください。セキュリティ勧告があったり放棄されたりしているパッケージのインストールを許容します。 COMPOSER_NO_SECURITY_BLOCKINGも参照。
–no-blocking: このコマンドの間はすべてのポリシーによる遮断を無効にします。 COMPOSER_NO_BLOCKINGも参照。
–update-no-dev: --no-devオプションと共に依存関係の更新を走らせます。COMPOSER_NO_DEVも参照してください。
–update-with-dependencies (-w): 新しく要求するパッケージの依存関係も更新します。ただし根幹要件は除きます。 COMPOSER_WITH_DEPENDENCIES=1 環境変数でも設定できます。
–update-with-all-dependencies (-W): 新しく要求するパッケージの依存関係も更新します。根幹要件も含まれます。 COMPOSER_WITH_ALL_DEPENDENCIES=1 環境変数でも設定できます。
–ignore-platform-reqs: 全てのプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、ローカルマシンがたとえこれらを満たしていなくてもインストールを強行します。 platform設定オプションも参照してください。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視して、たとえローカルマシンが満たしていなかったとしても、インストールを強行します。ワイルドカードを使って複数の要件を無視できます。
–prefer-stable: 依存関係の安定板を選ぶようにします。COMPOSER_PREFER_STABLE=1環境変数を介しても設定できます。
–prefer-lowest: 依存関係の最も低いバージョンを選ぶようにします。最小バージョン要件を試す際に便利で、一般的には--prefer-stableと共に使われます。COMPOSER_PREFER_LOWERST=1環境変数を介しても設定できます。
–minimal-changes (-m): -w / -Wでの更新の際に、遷移的な依存関係に関して絶対に必須の変更のみを実施するようにします。 COMPOSER_MINIMAL_CHANGES=1環境変数を介して設定することもできます。
–sort-packages: パッケージをpackage.jsonで整列した状態にします。
–optimize-autoloader (-o): PSR-0自動読み込みをクラスマップに変換して、より高速な自動読み込み器を取得します。特に実運用で推奨されますが、走らせるのに少し時間が掛かるため、現時点では既定では有効になっていません。
–classmap-authoritative (-a): クラス対応表からクラスのみを自動読み込みします。暗黙裡に--optimize-autoloaderを有効にします。
–apcu-autoloader: APCuを使って、クラスの有無をキャッシュします。
–apcu-autoloader-prefix: APCu自動読み込み器のキャッシュ用に独自の接頭辞を使います。暗黙裡に--apcu-autoloaderを有効にします。

remove / rm / uninstall

removeコマンドは現在のディレクトリにあるcomposer.jsonファイルからパッケージを削除します。

php composer.phar remove vendor/package vendor/package2

要件を削除した後は変更対象の要件がアンインストールされます。

オプション

–unused： 直接ないし間接の依存関係ではない（なくなった）、使われていないパッケージを削除します。
–dev: require-devからパッケージを削除します。
–dry-run: 実際には何もせず、コマンドを模擬します。
–no-progress: 進捗表示を除きます。バックスペース文字を扱わない端末やスクリプトではこの表示があることで散らかってしまうからです。
–no-update: 依存関係の自動的な更新を無効にします（–no-installを暗示します）。
–no-install: composer.lockを更新した後のインストール過程を走らせません。
–no-audit: インストールが完了した後の監査過程を走らせないようにします。 COMPOSER_NO_AUDITも参照してください。
–audit-format: 監査の出力形式です。 “table”、“plain”、“json”、または“summary“（既定）のどれかでなければなりません。
–no-security-blocking: 非推奨であり、--no-blockingを代用してください。セキュリティ勧告があったり放棄されたりしているパッケージのインストールを許容します。 COMPOSER_NO_SECURITY_BLOCKINGも参照。
–no-blocking: このコマンドの間はすべてのポリシーによる遮断を無効にします。 COMPOSER_NO_BLOCKINGも参照。
–update-no-dev: –no-devオプションで依存関係の更新を走らせます。COMPOSER_NO_DEVも参照してください。
–update-with-dependencies (-w): 削除されたパッケージの依存関係も更新します。 COMPOSER_WITH_DEPENDENCIES=1 環境変数でも設定できます（廃止されました。現在は既定の挙動になっています）。
–update-with-all-dependencies (-W): 全ての継承する依存関係が更新されるようにします。根幹要件のものも含みます。 COMPOSER_WITH_ALL_DEPENDENCIES=1 環境変数でも設定できます。
–minimal-changes (-m): -w / -Wでの更新の際に、遷移的な依存関係に関して絶対に必須の変更のみを実施するようにします。 COMPOSER_MINIMAL_CHANGES=1環境変数を介して設定することもできます。
–ignore-platform-reqs: 全てのプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、ローカルマシンがたとえこれらを満たしていなくてもインストールを強行します。 platform設定オプションも参照してください。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視して、たとえローカルマシンが満たしていなかったとしても、インストールを強行します。ワイルドカードを使って複数の要件を無視できます。
–optimize-autoloader (-o): PSR-0の自動読み込みをクラス対応表に変換して自動読み込みを高速にします。実運用では特にお勧めしますが、走らせるのに少し時間が掛かることがあるので、現在は既定ではされません。
–classmap-authoritative (-a): クラス対応表からクラスのみを自動読み込みします。暗黙裡に--optimize-autoloaderを有効にします。
–apcu-autoloader: APCuを使って、クラスの有無をキャッシュします。
–apcu-autoloader-prefix: APCu自動読み込み器のキャッシュ用に独自の接頭辞を使います。暗黙裡に--apcu-autoloaderを有効にします。

bump

bumpコマンドはcomposer.jsonの要件の下限を現在インストールされているバージョンに引き上げます。これにより依存関係が何らかの競合によりうっかりダウングレードされてしまわないようになったり、Composerが探すパッケージのバージョンの数が抑えられるため依存関係解決を僅かに向上させられます。

許される依存関係を狭めてしまうため、ライブラリでこれを無闇に走らせるのは推奨されません。依存関係を狭めることは利用者に依存関係地獄を招きかねません。しかしライブラリで--dev-onlyを走らせるのは、開発用要件がライブラリに対して局所的で、パッケージの消費者には影響しないため問題ないでしょう。

オプション

–dev-only: “require-dev” 中の要件のみbumpします。
–no-dev-only: “require” にある要件のみbumpします。
–dry-run: bumpするパッケージを出力しますが、何も実行しません。

reinstall

reinstallコマンドは名前からインストールされているパッケージを見付けだし、アンインストールと再インストールをします。こうすることでファイルを散らかしたり–prefer-installを使ってインストールの種類を変えたいと思ったりしたときにクリーンインストールできます。

php composer.phar reinstall acme/foo acme/bar

再インストールするパッケージ名を1つ以上指定できます。またはワイルドカードを使って複数パッケージの一括選択もできます。

php composer.phar reinstall "acme/*"

オプション

–prefer-install: パッケージをダウンロードする方法はsourceとdistの2つあります。 Composerはdistを既定で使います。 --prefer-install=source（または--prefer-source）を渡すと、Composerは、もしあればsourceからインストールします。プロジェクトへのバグ修正をして、依存関係のローカルgitクローンを直接取得したい場合に便利です。 Composerがパッケージの開発版用のsourceを自動的に使う、以前の挙動にしたければ、--prefer-install=autoを使ってください。 config.preferred-installも参照してください。このフラグを渡すと、設定値より優先されます。
–source-fallback / –no-source-fallback: Override the config.source-fallback setting. When disabled, Composer will not fall back to an alternative download source (e.g., from dist to source or vice versa) if the preferred one fails. Also see COMPOSER_SOURCE_FALLBACK.
–no-autoloader: 自動読み込み器の生成を飛ばします。
–no-progress: 進捗表示を除きます。バックスペース文字を扱わない端末やスクリプトではこの表示があることで散らかってしまうからです。
–optimize-autoloader (-o): PSR-0の自動読み込みをクラス対応表に変換して自動読み込みを高速にします。実運用では特にお勧めしますが、走らせるのに少し時間が掛かることがあるので、現在は既定ではされません。
–classmap-authoritative (-a): クラス対応表からクラスのみを自動読み込みします。暗黙裡に--optimize-autoloaderを有効にします。
–apcu-autoloader: APCuを使って、クラスの有無をキャッシュします。
–apcu-autoloader-prefix: APCu自動読み込み器のキャッシュ用に独自の接頭辞を使います。暗黙裡に--apcu-autoloaderを有効にします。
–ignore-platform-reqs: 全てのプラットフォーム要件を無視します。再インストールコマンド用の自動読み込み器の生成のときにのみ効果があります。
–ignore-platform-req: 特定のプラットフォーム要件を無視します。再インストールコマンド用の自動読み込み器の生成のときにのみ効果があります。複数の要件をワイルドカードで無視できます。

check-platform-reqs

check-platform-reqsコマンドはPHPと拡張のバージョンがインストールされているパッケージのプラットフォーム要件を満たしているかを確認します。例えば実運用サーバーでインストール後に、プロジェクトを走らせるのに必要な全ての拡張があることを検証したいときに使えます。

updateやinstallとは異なり、このコマンドはconfig.platform設定を無視し、実際のプラットフォームパッケージを検査します。そのため要求されているプラットフォーム依存関係があることを確かめられます。

オプション

–lock: インストールされたパッケージからではなく、固定ファイルのみから要件を検査します。
–no-dev: require-devのパッケージ要件の検査を無効にします。
–format (-f): 出力の書式です。text（既定）またはjsonです。

global

globalコマンドはinstall、remove、require、updateのようなコマンドをあたかもCOMPOSER_HOMEディレクトリから走らせているように実行できます。

中心的な場所に保管されたプロジェクトを管理するためのただの補助であり、CLIツールやComposerプラグインのような、どこでも使えるようにしたいものを置いておけます。

大域的にCLIユーティリティをインストールするのに使えます。以下は一例です。

php composer.phar global require friendsofphp/php-cs-fixer

これでphp-cs-fixerバイナリが大域的に使えるようになりました。大域的なベンダーバイナリディレクトリが$PATH環境変数の中にあるようにしてください。インストールした場所は以下のコマンドで得られます。

php composer.phar global config bin-dir --absolute

後になってバイナリを更新したいと思ったら、global updateを走らせられます。

php composer.phar global update

search

searchコマンドを使うと、現在のプロジェクトのパッケージリポジトリ全体を検索できます。大抵はpackagistです。検索したい用語を渡せます。

php composer.phar search monolog

複数の引数を渡すことで1つ以上の用語を探すこともできます。

オプション

–only-name (-N): パッケージの名前のみから検索します。
–only-vendor (-O): ベンダー・組織名のみから検索します。結果として「ベンダー」のみが返ります。
–type (-t): 特定のパッケージの種類から探します。
–format (-f): text（既定）かjson出力かのどちらかを選べます。 jsonではname及びdescriptionキーのみが存在することが保証されています。残り（url、repository、downloads、favers）はPackagist.orgの検索結果で得られるものであって、その他のリポジトリが返す情報はそれより多かったり少なかったりします。

show / info

使えるパッケージの全てを一覧にするにはshowコマンドが使えます。

php composer.phar show

一覧を絞り込むには、ワイルドカードを使ってパッケージマスクを渡せます。

php composer.phar show "monolog/*"

monolog/monolog 2.4.0 Sends your logs to files, sockets, inboxes, databases and various web services

何かのパッケージの詳細を見たければ、パッケージ名を渡すことができます。

php composer.phar show monolog/monolog

name     : monolog/monolog
descrip. : Sends your logs to files, sockets, inboxes, databases and various web services
keywords : log, logging, psr-3
versions : * 1.27.1
type     : library
license  : MIT License (MIT) (OSI approved) https://spdx.org/licenses/MIT.html#licenseText
homepage : http://github.com/Seldaek/monolog
source   : [git] https://github.com/Seldaek/monolog.git 904713c5929655dc9b97288b69cfeedad610c9a1
dist     : [zip] https://api.github.com/repos/Seldaek/monolog/zipball/904713c5929655dc9b97288b69cfeedad610c9a1 904713c5929655dc9b97288b69cfeedad610c9a1
names    : monolog/monolog, psr/log-implementation

support
issues : https://github.com/Seldaek/monolog/issues
source : https://github.com/Seldaek/monolog/tree/1.27.1

autoload
psr-4
Monolog\ => src/Monolog

requires
php >=5.3.0
psr/log ~1.0

パッケージのバージョンを渡すこともできます。こうすると特定のバージョンでの詳細が分かります。

php composer.phar show monolog/monolog 1.0.2

オプション

–all: リポジトリで使える全てのパッケージを一覧にします。
–installed (-i): インストールされているパッケージを一覧にします（既定で有効になっており、時代遅れのオプションです）。
–locked: composer.lockから固定されたパッケージを一覧にします。
–platform (-p): プラットフォームパッケージ（phpと拡張）のみを一覧にします。
–available (-a): 利用できるパッケージのみにします。
–self (-s): 根幹パッケージ情報を一覧にします。
–name-only (-N): パッケージ名のみを一覧にします。
–path (-P): パッケージのパスを一覧にします。
–tree (-t): 依存関係を木構造で一覧にします。パッケージ名を渡した場合はそのパッケージの依存関係を示します。
–latest (-l): インストールされている全てのパッケージをその最新バージョンと共に一覧にします。
–outdated (-o): –latestを暗示しますが、新しいバージョンが手に入るパッケージのみを一覧にします。
–ignore: ワイルドカード (*) を含められます。指定されたパッケージを無視します。パッケージの新しいバージョンについて通知を受けたくなければ–outdatedオプションと一緒に使ってください。
–no-dev: パッケージ一覧から開発用の依存関係を除外します。
–major-only (-M): –latestまたは–outdatedと一緒に使ってください。メジャーなセマンティックバージョニング互換の更新があるパッケージのみ示されます。
–minor-only (-m): –latestまたは–outdatedと一緒に使ってください。マイナーなセマンティックバージョニング互換の更新があるパッケージのみ示されます。
–patch-only: –latestまたは–outdatedと一緒に使ってください。パッチ水準のセマンティックバージョニング互換の更新があるパッケージのみが示されます。
–sort-by-age (-A): インストールされたバージョンの経過時間を表示し、古い順にパッケージを整列します。 –latestないし–outdatedオプションと一緒に使ってください。
–direct (-D): パッケージの一覧を直接的な依存関係に限定します。
–strict: 時代遅れのパッケージがあるときは非ゼロの終了コードを返します。
–format (-f): 出力形式としてtext（既定）ないしjsonを選びます。
–ignore-platform-reqs: 全てのプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、たとえローカルマシンがこれらの要件を満たしていなくても、インストールを強行します。–outdatedオプションと一緒に使ってください。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、たとえローカルマシンがその要件を満たしていなくても、インストールを強行します。ワイルドカードを介して複数の要件を無視できます。 –outdatedオプションと一緒に使ってください。

outdated

outdatedコマンドは、更新が利用できるインストール済みパッケージの一覧を、現在のバージョンと最新のバージョンを含めて示します。基本的にcomposer show -loの別名になっています。

色彩コードは以下の通り。

green (=): 依存関係は最新バージョンであり、最新式です。
yellow (~): 依存関係に新しいバージョンが利用できるものがありますが、セマンティックバージョニングに於ける後方互換性の破壊が含まれます。そのため更新できそうならしても良いですが、作業が発生する可能性があります。
red (!): 依存関係にセマンティックバージョニング上互換性のある新しいバージョンがあり、更新するべきです。

オプション

–all (-a): 時代遅れのものだけでなく、全てのパッケージを示します（composer show --latestの別名です）。
–direct (-D): パッケージの一覧を直接的な依存関係に限定します。
–strict: 1つもパッケージが時代遅れでなければ、非ゼロの終了コードを返します。
–ignore: 指定されたパッケージを無視します。ワイルドカード (*) を含められます。何かしらのパッケージの新しいバージョンについて知らされたくないときに使ってください。
–major-only (-M): メジャーなセマンティックバージョニング上の互換性を伴う更新のみ示します。
–minor-only (-m): マイナーなセマンティックバージョニング上の互換性を伴う更新のみ示します。
–patch-only (-p): パッチ水準のセマンティックバージョニング上の互換性を伴う更新のみ示します。
–sort-by-age (-A): インストールされたバージョンの経過時間を表示し、古い順にパッケージを整列します。
–format (-f): 出力形式としてtext（既定）ないしjsonを選びます。
–no-dev: 時代遅れの開発用依存関係を表示しません。
–locked: 固定ファイルを元にしたパッケージの更新を示します。現在のベンダーディレクトリの中身は措かれます。
–ignore-platform-reqs: 全てのプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、たとえローカルマシンがこれらの要件を満たしていなくても、インストールを強行します。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視して、たとえローカルマシンが満たしていなかったとしても、インストールを強行します。ワイルドカードを使って複数の要件を無視できます。

browse / home

browse（別名home）はパッケージのリポジトリURLまたはホームページをブラウザで開きます。

オプション

–homepage (-H): リポジトリではなくホームページのURLを開きます。
–show (-s): ホームページないしリポジトリのURLを表示するだけにします。

suggests

現在インストールされているパッケージの集合から提案される全てのパッケージを一覧にします。おまけとして複数のパッケージ名をvendor/packageの形式で渡し、これらのパッケージのみについて提案を出力するように制限できます。

--by-package（既定）ないし--by-suggestionフラグを使って出力をグループ分けできます。それぞれ提案を行うパッケージによるグループ分けと提案されたパッケージによるグループ分けになっています。

提案されたパッケージ名の一覧だけが欲しければ--listを使ってください。

オプション

–by-package: 提案を行ったパッケージによって出力をグループ分けします（既定）。
–by-suggestion: 提案されたパッケージによって出力をグループ分けします。
–all: 推移的なものを含む全ての依存関係から提案を示します（既定では直接的な依存関係の提案のみが示されます）。
–list: 提案されたパッケージ名のみを一覧として示します。
–no-dev: require-devパッケージからの提案を除外します。

fund

依存関係の維持管理に投資して支援する方法が分かります。このコマンドはインストールされている依存関係から全ての投資のリンクを一覧にします。機械で読むことのできる出力を得るには--format=jsonを使ってください。

オプション

–format (-f): 出力形式としてtext（既定）ないしjsonを選びます。

depends / why

dependsコマンドは特定のパッケージに依存する他のパッケージを教えてくれます。インストールの際、require-devの関係は根幹パッケージのみ考慮されます。

php composer.phar depends doctrine/lexer

doctrine/annotations  1.13.3 requires doctrine/lexer (1.*)
doctrine/common       2.13.3 requires doctrine/lexer (^1.0)

おまけとしてパッケージの後にバージョン制約を指定することで検索結果を絞り込むことができます。

--treeや-tフラグを加えると、なぜそのパッケージが依存されているのかの再帰的な木構造が示されます。例えば以下の通りです。

php composer.phar depends psr/log -t

psr/log 1.1.4 Common interface for logging libraries
├──composer/composer 2.4.x-dev (requires psr/log ^1.0 || ^2.0 || ^3.0)
├──composer/composer dev-main (requires psr/log ^1.0 || ^2.0 || ^3.0)
├──composer/xdebug-handler 3.0.3 (requires psr/log ^1 || ^2 || ^3)
│  ├──composer/composer 2.4.x-dev (requires composer/xdebug-handler ^2.0.2 || ^3.0.3)
│  └──composer/composer dev-main (requires composer/xdebug-handler ^2.0.2 || ^3.0.3)
└──symfony/console v5.4.11 (conflicts psr/log >=3) (circular dependency aborted here)

オプション

–recursive (-r): 再帰的に根幹パッケージまで木構造を解決します。
–tree (-t): 入れ子の木構造を結果に出力します。-rを暗示します。

prohibits / why-not

prohibitsコマンドを使うと与えられたパッケージがインストールされる上でどのパッケージが障壁になっているのかが分かります。バージョン制約を指定するとプロジェクトにおいて更新が実施できるかを検証し、もしできなければその理由を示します。以下の例をご覧ください。

php composer.phar prohibits symfony/symfony 3.1

laravel/framework v5.2.16 requires symfony/var-dumper (2.8.*|3.0.*)

なおプラットフォーム要件も指定できます。例えばサーバーをPHP 8.0に更新できるかどうかを確認するにはこうします。

php composer.phar prohibits php 8

doctrine/cache        v1.6.0 requires php (~5.5|~7.0)
doctrine/common       v2.6.1 requires php (~5.5|~7.0)
doctrine/instantiator 1.0.5  requires php (>=5.3,<8.0-DEV)

dependsと同様に再帰的な探索を求めることができます。その場合は競合を起こしているパッケージに依存している全てのパッケージを一覧にします。

オプション

–recursive (-r): 再帰的に根幹パッケージまで木構造を解決します。
–tree (-t): 入れ子の木構造を結果に出力します。-rを暗示します。

validate

composer.jsonファイル（と、当てはまるときはcomposer.lock）をコミットしたり、リリースのタグ付けをしたりする前には、必ずvalidateコマンドを走らせるべきです。

composer.jsonが正当であるか検査します。 composer.lockがあるとき、composer.jsonに対して最新かも検査します。

php composer.phar validate

オプション

–no-check-all: composer.json中の要件が範囲のないものであったり、過度に厳密なバージョン制約であったりする場合について、警告を出しません。
–no-check-lock: composer.lockが存在し、且つ更新されていない場合について、警告を出しません。
–check-lock 固定ファイルが最新か検査します（config.lockが偽の場合も含みます）
–no-check-publish: Packagistに投稿するには相応しくないが、そうでなければ妥当なcomposer.jsonになっている場合について、エラーを出しません。
–no-check-version: バージョンフィールドがあるとき、警告を出しません。
–with-dependencies: 全てのインストールされた依存関係についてもcomposer.jsonを検証します。
–strict: エラーに加えて警告についても非ゼロの終了コードを返します。

status

依存関係のコードを変更したり、ソースからインストールしたりする必要がしばしばある場合は、statusコマンドを使うとその中からローカルで加えた変更があるか確認できます。

php composer.phar status

--verboseコマンドで変化したところについてのより詳しい情報を得られます。

php composer.phar status -v

You have changes in the following dependencies:
vendor/seld/jsonlint:
    M README.mdown

self-update / selfupdate

Composer自体を最新版に更新したければself-updateコマンドを走らせてください。composer.pharを最新版に置き換えます。

php composer.phar self-update

そうではなく特定のリリースに更新したければそのように指定してください。

php composer.phar self-update 2.4.0-RC1

Composerをシステム全体にインストールしたときは（大域的なインストールを参照）、コマンドをroot権限で走らせなくてはならないかもしれません。

sudo -H composer self-update

ComposerがPHARとしてインストールされていなければこのコマンドは使えません（Composerがオペレーティングシステムのパッケージ管理によってインストールされたときはこの場合に当たることがあります）。

オプション

–rollback (-r): インストールした直近のバージョンに巻き戻します。
–clean-backups: 更新時に古いバックアップを削除します。更新後は現在のComposerのバージョンのみがバックアップとして残ります。
–no-progress: ダウンロードの進捗バーを出力しません。
–update-keys: キーの更新を利用者に尋ねます。
–stable: 更新を安定チャンネルに強制します。
–preview: 更新をプレビューチャンネルに強制します。
–snapshot: 更新をスナップショットチャンネルに強制します。
–1: 更新を安定チャンネルに強制しますが、1.x版のみを使います。
–2: 更新を安定チャンネルに強制しますが、2.x版のみを使います。
–set-channel-only: チャンネルを既定のものとして保存するだけして終了します。

config

configコマンドではローカルのcomposer.jsonファイルまたは大域的なconfig.jsonファイルにあるComposerの設定やリポジトリを編集できます。

加えてローカルのcomposer.jsonにある殆どのプロパティを編集できます。

php composer.phar config --list

使い方

config [options] [setting-key] [setting-value1] ... [setting-valueN]

setting-keyは設定のオプション名で、setting-value1は設定値です。（github-protocolsのような）値の配列を取ることができる設定については、複数の設定値の引数が可能です。

プロパティの値を編集することもできます。

description、homepage、keywords、license、minimum-stability、name、prefer-stable、type、versionがそうです。

妥当な設定オプションについては設定の章を参照してください。

オプション

–global (-g): 既定では$COMPOSER_HOME/config.jsonに位置する大域設定ファイルを編集します。このオプションがなければ、このコマンドはローカルのcomposer.jsonファイルないし–file`により指定されたファイルに作用します。
–editor (-e): ローカルのcomposer.jsonファイルをEDITOR環境変数で定義されたテキストエディタを使って開きます。--globalオプションと一緒に使うと大域設定ファイルを開きます。
–auth (-a): 認証設定ファイルに作用します（–editorの使用限定です）。
–unset: setting-keyの名前が付いている設定要素を削除します。
–list (-l): 現在の設定変数の一覧を示します。globalオプションと一緒に使うと大域設定のみを一覧にします。
–file=“…” (-f): composer.jsonではなく特定のファイルについて編集します。なお、--globalオプションと織り交ぜて使うことはできません。
–absolute: *-dir設定値を取得するとき、相対パスではなく絶対パスを返します。
–json: 設定値をJSONでデコードします。このデコード結果はextra.*キーで使うことができます。
–merge: 設定値を現在の値と統合します。--jsonと組み合わせてextra.*キーに使えます。
–append: リポジトリを追加するとき、既存のものの先頭に追加する（最優先）のではなく末尾に付ける（低優先）ようにします。
–source: 設定値がどこから読み込まれたのかを表示します。

リポジトリを変更する

設定部分を変更することに加えて、configコマンドを以下のように使うことでリポジトリ部分を変更することにも対応しています。

php composer.phar config repositories.foo vcs https://github.com/foo/bar

リポジトリにより多くの設定オプションが必要なら、代わりにそのJSON表現を渡すことができます。

php composer.phar config repositories.foo '{"type": "vcs", "url": "http://svn.example.org/my-project/", "trunk-path": "master"}'

追加の値を変更する

設定部分を変更することに加えて、configコマンドを以下のように使って追加部分を変更することにも対応しています。

php composer.phar config extra.foo.bar value

ドットは入れ子の連なりを表していますが、深さは3段階までです。上は"extra": { "foo": { "bar": "value" } }を設定します。

複雑な値を加えたり変更したりする場合は--jsonや--mergeフラグを使って追加のフィールドをJSONとして編集できます。

php composer.phar config --json extra.foo.bar '{"baz": true, "qux": []}'

repository / repo

repoコマンドではcomposer.jsonのリポジトリを管理できます。 composer config repositories.*を使ってリポジトリの構成を編集するより強力であり、お勧めです。使える種別と構成オプションについて、詳しくはRepositoriesの文書を参照してください。

使い方

repo [オプション] list
repo [オプション] add [リポジトリ名] [リポジトリ種別] [url]
repo [オプション] add [リポジトリ名] [jsonのリポジトリの定義]
repo [オプション] remove [リポジトリ名]
repo [オプション] set-url [リポジトリ名] [url]
repo [オプション] get-url [リポジトリ名]
repo [オプション] enable packagist.org
repo [オプション] disable packagist.org

オプション

–global (-g): 大域的な $COMPOSER_HOME/config.json を変更します。
–file (-f): composer.jsonの代わりに特定のファイルを変更します。
–append: 低い優先度でリポジトリを追加します（既定ではリポジトリは前置されます。したがって既存のものより高い優先度があります）。
–before [名前]: 新しいリポジトリを既存の [名前] という名前のリポジトリの前に挿入します。
–after [名前]: 新しいリポジトリを既存の [名前] というリポジトリの後に挿入します。 [名前] は既存のリポジトリ名に合致しなければなりません。

例

php composer.phar repo list
php composer.phar repo add foo vcs https://github.com/acme/foo
php composer.phar repo add bar composer https://repo.packagist.com/bar
php composer.phar repo add zips '{"type":"artifact","url":"/path/to/dir/with/zips"}'
php composer.phar repo add baz vcs https://example.org --before foo
php composer.phar repo add qux vcs https://example.org --after bar
php composer.phar repo remove foo
php composer.phar repo set-url foo https://git.example.org/acme/foo
php composer.phar repo get-url foo
php composer.phar repo disable packagist.org
php composer.phar repo enable packagist.org

The policy command lets you manage custom policy lists and their sources in your composer.json under config.policy. A source points Composer at a remote URL which provides the list of packages the policy applies to. Adding a source to a list that does not yet exist will create the list entry automatically.

Built-in lists (advisories, malware, abandoned) do not accept sources and are rejected. To change their settings, use composer config policy.<list>.<field> instead — see the policy config documentation.

使い方

policy [options] add-source [list-name] [source-type] [url]
policy [options] add-source [list-name] [json-source-definition]

Currently only url is supported as source-type, and URLs must start with https://.

オプション

–global (-g): 大域的な $COMPOSER_HOME/config.json を変更します。
–file (-f): composer.jsonの代わりに特定のファイルを変更します。

例

php composer.phar policy add-source my-list url https://example.org/list.json
php composer.phar policy add-source my-list '{"type":"url","url":"https://example.org/list.json"}'

create-project

Composerを使って既存のパッケージから新しいプロジェクトを作ることができます。 git cloneやsvn checkoutをしてから、ベンダーにあるものをcomposer installすることと等価です。

このコマンドにはいくつかの活用法があります。

アプリケーションパッケージをデプロイできます。
任意のパッケージをチェックアウトして、例えばパッチを開発できます。
複数人の開発者がいるプロジェクトでこの機能を使い、開発のための初期のアプリケーションに着手できます。

Composerで新しいプロジェクトを作るためにはcreate-projectコマンドが使えます。パッケージ名とプロジェクトを作成するディレクトリを渡してください。また、3つ目の引数としてバージョンを与えることもでき、与えない場合は最新版が使われます。

ディレクトリがその時点で存在しなければインストールの過程で作られます。

php composer.phar create-project composer/hello-world my-project

プロジェクトに着手するための既存のcomposer.jsonがあるディレクトリ内では、引数がなくともコマンドを走らせることができます。

既定ではコマンドはパッケージをpackagist.orgで確認します。

オプション

–stability (-s): パッケージの最小安定性です。stableが既定です。
–prefer-install: パッケージをダウンロードする方法はsourceとdistの2つあります。 Composerはdistを既定で使います。 --prefer-install=source（または--prefer-source）を渡すと、Composerは、もしあればsourceからインストールします。プロジェクトへのバグ修正をして、依存関係のローカルgitクローンを直接取得したい場合に便利です。 Composerがパッケージの開発版用のsourceを自動的に使う、以前の挙動にしたければ、--prefer-install=autoを使ってください。 config.preferred-installも参照してください。このフラグを渡すと、設定値より優先されます。
–source-fallback / –no-source-fallback: Override the config.source-fallback setting. When disabled, Composer will not fall back to an alternative download source (e.g., from dist to source or vice versa) if the preferred one fails. Also see COMPOSER_SOURCE_FALLBACK.
–repository: パッケージを探索するための独自のリポジトリを与えます。このリポジトリはpackagistの代わりに使われます。composerディレクトリを指すHTTP URLでも、ローカルのpackages.jsonファイルへのパスでも、あるいはリポジトリキーが受け付けるものに似たJSON文字列でも大丈夫です。複数回使って複数のリポジトリを設定できます。
–add-repository: composer.jsonの中に独自のリポジトリを加えます。固定ファイルが存在している場合、一旦削除されインストールの代わりに更新が走ります。
–dev: require-devに挙げられたパッケージをインストールします。
–no-dev: require-devのパッケージのインストールを無効にします。
–no-scripts: 根幹パッケージで定義されているスクリプトの実行を無効にします。
–no-progress: 進捗表示を除きます。バックスペース文字を扱わない端末やスクリプトではこの表示があることで散らかってしまうからです。
–no-secure-http: 根幹パッケージのインストール中、一時的にsecure-http設定オプションを無効にします。自己責任でご利用ください。このフラグを使うのは関心しません。
–keep-vcs: 作成されるプロジェクトのVCSメタデータの削除を飛ばします。これが役に立つのはコマンドを非対話的なモードで走らせているときが殆どです。
–remove-vcs: プロンプト無しにVCSメタデータを強制削除します。
–no-install: ベンダーのインストールを無効にします。
–no-audit: インストールが完了した後の監査過程を走らせないようにします。 COMPOSER_NO_AUDITも参照してください。
–audit-format: 監査の出力形式です。 “table”、“plain”、“json”、または“summary“（既定）のどれかでなければなりません。
–no-security-blocking: 非推奨であり、--no-blockingを代用してください。セキュリティ勧告があったり放棄されたりしているパッケージのインストールを許容します。 COMPOSER_NO_SECURITY_BLOCKINGも参照。
–no-blocking: このコマンドの間はすべてのポリシーによる遮断を無効にします。 COMPOSER_NO_BLOCKINGも参照。
–ignore-platform-reqs: 全てのプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、ローカルマシンがたとえこれらを満たしていなくてもインストールを強行します。 platform設定オプションも参照してください。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視して、たとえローカルマシンが満たしていなかったとしても、インストールを強行します。ワイルドカードを使って複数の要件を無視できます。
–require: Require additional package(s) to be added to composer.json after installing the project. If a lock file is present it will be deleted and an update will be run instead of install. Can be specified multiple times for multiple packages. Should be in format foo/bar:1.0.0 format if you want to specify a constraint.
–ask: 利用者に新しいプロジェクトの対象ディレクトリを入れてもらうようにします。

dump-autoload / dumpautoload

例えばクラスマップパッケージ中に新しいクラスができたことによって自動読み込み器を更新する必要がある場合は、インストールや更新を行わずともdump-autoloadが使えます。

加えて、効率性の理由からPSR-0/4のパッケージをクラスマップのものに変換する、最適化された自動読み込み器を吐き出すことができます。多くのクラスがある比較的大規模なアプリケーションでは、自動読み込み器には毎回のリクエストに掛かる時間のうち無視できない時間が掛かります。開発時に常にクラスマップを使うことはあまり便利ではありませんが、このオプションを使えば便宜上PSR-0/4を使いつつも、効率性のためにクラスマップを使うことができます。

オプション

–optimize (-o): PSR-0/4自動読み込みをクラスマップに変換し、より高速な自動読み込み器を得ます。実運用で特に推奨されますが、走らせるのに少し時間が掛かるため、現時点では既定で有効になっていません。
–classmap-authoritative (-a): クラスマップからのみクラスを自動読み込みします。暗に--optimizeを有効します。
–apcu: APCuを使って、クラスの有無をキャッシュします。
–apcu-prefix: APCu自動読み込み器のキャッシュに独自の接頭辞を使います。暗に--apcuを有効にします。
–dry-run: 操作内容を出力しますが、何も実行しません。
–no-dev: autoload-dev規則を無効にします。既定では、Composerは直近のinstall --no-devまたはupdate --no-devの状態に随って自動的にこれを推測します。
–dev: autoload-dev規則を有効にします。既定では、Composerは直近のinstall --no-devまたはupdate --no-devの状態に随って自動的にこれを推測します。
–ignore-platform-reqs: 全てのphp、hhvm、lib-*、ext-*要件を無視し、これらのプラットフォーム検査を飛ばします。platform設定オプションも参照してください。
–ignore-platform-req: 特定のプラットフォーム要件（php、hhvm、lib-*、ext-*）を無視し、それについてのプラットフォーム検査を飛ばします。ワイルドカードを使って複数の要件を無視できます。
–strict-psr: 現在のプロジェクトで、PSR-4またはPSR-0の対応付けで失敗する場合、失敗の終了コード (1) を返します。動作には--optimizeが必要です。
–strict-ambiguous: 複数ファイルに同じクラスがあるとき、失敗の終了コード (2) を返します。動作には--optimizeが必要です。

clear-cache / clearcache / cc

Composerのキャッシュディレクトリから全ての内容を削除します。

オプション

–gc: ガベージコレクションのみを走らせます。完全なキャッシュの消去は行いません。

licenses

インストールされている全てのパッケージの名前、バージョン、使用許諾を一覧にします。 --format-jsonを使うと、機械で読み込みやすい出力が得られます。

オプション

–locked: 固定ファイルのパッケージを監査します。現時点でベンダーディレクトリに何があるか無関係です。
–format: 出力形式です。 text、json、summaryの何れかです（既定では「text」）。
–no-dev: 出力から開発依存関係を除きます。

run-script / run

スクリプトを手動で走らせるにはこのコマンドを使うことができます。スクリプト名と任意で必要な引数を与えます。

オプション

–timeout: スクリプトの制限時間を秒単位で設定します。0は制限時間無しです。
–dev: 開発モードを設定します。
–no-dev: 開発モードを無効にします。
–list (-l): 利用者が定義したスクリプトを一覧にします。

exec

ベンダーのバイナリやスクリプトを実行します。どんなコマンドも実行できますし、コマンドが走る前に必ずComposerのbin-dirがPATHに加えられます。

オプション

–list (-l): 利用できるComposerのバイナリを一覧にします。

diagnose

バグや奇妙な挙動を発見したと思ったら、diagnoseコマンドを走らせて、多くのよくある問題について自動化された検査を実施できます。

php composer.phar diagnose

audit

このコマンドを使うと、インストールしたパッケージに対し、セキュリティ上の問題がありうるか監査できます。既定ではPackagist.org apiを使い、セキュリティ上の脆弱性に対する推奨事項を確認して一覧にします。 composer.jsonのrepositories節で指定されたときは、他のリポジトリが使われます。このコマンドでは、放棄されたパッケージも検出されます。

監査コマンドでは、脆弱であったり、放棄されていたり、遮断されたパッケージがあるなら、見つかったものに基づいて、以下の終了コードを返します。

0 は、問題なし
1 は、脆弱なパッケージ
2 は、放棄されたパッケージ
3 は、脆弱なパッケージと放棄されたパッケージ
4 は、遮断されたパッケージ
5 は、脆弱なパッケージと遮断されたパッケージ
6 は、放棄されたパッケージと遮断されたパッケージ
7 は、脆弱なパッケージと放棄されたパッケージと遮断されたパッケージ

php composer.phar audit

オプション

–no-dev: require-devのパッケージの監査を無効にします。
–format (-f): 出力の形式を監査します。監査の出力は「table」（既定）、「plain」、「json」、「summary」の何れかです。
–locked: 固定ファイルのパッケージを監査します。現時点でベンダーディレクトリに何があるかは無視されます。
–abandoned: 放棄されたパッケージに対して動作します。「ignore」「report」「fail」のどれかでなければなりません。 config.audit.abandonedもご参照ください。このフラグを渡すと、構成値と環境変数がオーバーライドされます。
–ignore-severity: 特定の深刻度の水準の勧告を無視します。複数の深刻度を無視するために1回以上渡せます。
–filtered: Behavior on packages matched by malware and custom filter lists. Must be “ignore”, “report”, or “fail”. Overrides the per-list audit setting (config.policy.malware.audit and every custom list’s audit) for the duration of this command.

help

あるコマンドについて詳細が知りたければhelpが使えます。

php composer.phar help install

コマンドラインインターフェース

コマンドライン補完は、composer completion --helpコマンドを走らせると有効にできます。また、以下の手順に従ってください。

環境変数

環境変数を設定して多くの設定を上書きできます。できる限りこうした設定は環境変数ではなくcomposer.jsonのconfig部分で指定することをお勧めします。環境変数はcomposer.jsonで指定された値より常に優先されるということ以外に利点はありません。

COMPOSER

COMPOSER環境変数を設定することにより、composer.jsonのファイル名を何か別のものに設定できます。

例えば：

COMPOSER=composer-other.json php composer.phar install

生成される固定ファイルは同じ名前を使います。この例ではcomposer-other.lockです。

COMPOSER_ALLOW_SUPERUSER

1に設定すると、この環境変数はコマンドをルートないし特権のある利用者として走らせることについての警告を無効にします。自動的なsudoセッションの消去も無効にするため、必ずDockerコンテナのような特権のある利用者として、常時Composerを使うときにのみ設定するようにしてください。

COMPOSER_ALLOW_XDEBUG

1に設定すると、Xdebug拡張を持たないPHPを再始動させることなく、環境変数はXdebug拡張が有効のときにComposerを走らせられるようにします。

COMPOSER_AUTH

COMPOSER_AUTH変数では、環境変数として認証を設定できます。変数の内容はJSON形式のオブジェクトで、http-basic、github-oauth、bitbucket-oauth、……といった必要に応じたものです。オブジェクトは設定の仕様に従います。

COMPOSER_BIN_COMPAT

bin-compat構成設定をオーバーライドします。

COMPOSER_BIN_DIR

このオプションを設定するとbinディレクトリ（ベンダーバイナリ）をvendor/binとは違う別のどこかに変更できます。

COMPOSER_CACHE_DIR

COMPOSER_CACHE_DIR変数ではComposerのキャッシュディレクトリを変更できます。 cache-dirオプションを介しても設定できます。

Windowsにおいて既定ではC:\Users\<user>\AppData\Local\Composer（もしくは%LOCALAPPDATA%/Composer）を指します。 *nixシステムではXDG Base Directory Specificationsに従い、$XDG_CACHE_HOME/composerを指します。他の*nixシステムとmacOSにおいては$COMPOSER_HOME/cacheを指します。

COMPOSER_CAFILE

この環境値を設定することで、パスを証明書バンドルファイルに設定してSSL/TLSピア検証で使えるようにします。

COMPOSER_DISABLE_XDEBUG_WARN

1に設定すると、ComposerがXdebug拡張が有効の状態で走っているときに出す警告をこの環境変数により抑制します。

COMPOSER_DISCARD_CHANGES

この環境変数はdiscard-changes設定オプションを制御します。

COMPOSER_FUND

この環境変数を0に設定すると、インンストール時に投資のお知らせを抑制します。

COMPOSER_HOME

COMPOSER_HOME変数によりComposerのホームディレクトリを変えられます。全てのプロジェクトで共有される、隠された（マシン上の使用者毎の）大域的なディレクトリです。

composer config --global homeを使ってホームディレクトリの場所を確認してください。

既定では、WindowsにおいてはC:\Users\<user>\AppData\Roaming\Composerを、macOSにおいては/Users/<user>/.composerを指します。*nixシステムではXDG Base Directory Specificationsに従い、$XDG_CONFIG_HOME/composerを指します。他の*nixシステムでは/home/<user>/.composerを指します。

COMPOSER_HOME/config.json

config.jsonファイルをCOMPOSER_HOMEが指す場所に置くことができます。Composerはinstall及びupdateコマンドを走らせたとき、部分的に（configおよびrepositoriesキーのみ）この設定をプロジェクトのcomposer.jsonと統合します。

このファイルがあれば使用者のプロジェクト用にリポジトリと構成を設定できます。

大域的な設定がローカルの設定に合致した場合、プロジェクトのcomposer.jsonが常に優先されます。

COMPOSER_HTACCESS_PROTECT

既定では1です。0に設定するとComposerはComposerのホーム、キャッシュ、データディレクトリに.htaccessファイルを作りません。

COMPOSER_MEMORY_LIMIT

設定すると、その値がphpのメモリ上限として使われます。

COMPOSER_MIRROR_PATH_REPOS

1に設定すると、この環境変数は既定のパスリポジトリ戦略をsymlinkではなくmirrorに変更します。既定の戦略が設定されているため、リポジトリオプションで上書きすることもできます。

COMPOSER_NO_INTERACTION

1に設定すると、この環境変数によりComposerがあたかも全てのコマンドについて--no-interactionフラグを渡されたかのように動作します。 build box/CIで設定できます。

COMPOSER_PROCESS_TIMEOUT

この環境変数はコマンド（例えばgitコマンド）が実行終了するまでの待機時間を制御します。既定値は300秒（5分）です。

COMPOSER_ROOT_VERSION

この変数を設定することで、根幹パッケージのバージョンがVCSの情報から推測できず、composer.jsonにもないときに、そのバージョンを指定できます。

COMPOSER_VENDOR_DIR

この変数を設定することでComposerに依存関係をvendor以外のディレクトリにインストールさせられます。

COMPOSER_RUNTIME_ENV

これによりどの環境でComposerが走っているのかの手掛かりが得られ、Composerで何らかの環境特有の問題を回避するための助けになります。現在対応している唯一の値はvirtualboxで、こうするといくつかの短いsleep()呼び出しを有効にして、ファイルシステムが適切にファイルに書き込むのを待ってからそのファイルを読み込むようにします。 VagrantやVirtualboxを使っていてファイルが存在しているのにも関わらずインストール時にファイルがない旨問題に遭遇したときは、この環境変数を設定すると良いでしょう。

http_proxyやHTTP_PROXY

HTTP_PROXY_REQUEST_FULLURI

HTTPS_PROXY_REQUEST_FULLURI

no_proxyやNO_PROXY

プロキシの環境変数の使い方についての詳細は、プロキシのドキュメントを参照してください。

COMPOSER_MAX_PARALLEL_HTTP

整数を指定し、並列で何個のファイルをダウンロードするか設定します。既定で12になっており、1から50の間でなければいけません。プロキシに並列性の問題があるときはこの値を下げたいかもしれません。この値を増加させても一般には効率性が上がる結果にはならないでしょう。

COMPOSER_MAX_PARALLEL_PROCESSES

Set to an integer to configure how many processes can be executed in parallel. This defaults to 10 and must be between 1 and 50.

COMPOSER_IPRESOLVE

4ないし6に設定するとそれぞれIPv4ないしIPv6の解決を強制します。ダウンロード用にcurl拡張が使用されている場合にのみ機能します。

COMPOSER_SELF_UPDATE_TARGET

設定した場合、self-updateコマンドが元あるファイルではなく与えられたパスに新しいComposerのpharファイルを書き込むようにします。読み込み専用のファイルシステムでComposerを更新するときに便利です。

COMPOSER_DISABLE_NETWORK

1に設定するとネットワークアクセスを（最大限の努力で）無効にします。この変数はComposerをデバッグしたり貧弱な接続環境下で走らせたりするのに使えます。

primeに設定した場合、GitHub VCSリポジトリはキャッシュに前もって溜め込んでおくため、1で完全にオフラインで使えるようになります。

COMPOSER_DEBUG_EVENTS

1に設定するとディスパッチされたイベントについての情報を出力します。プラグインの作者にとって何が厳密にどの時点で発火しているのか特定するのに便利かもしれません。

COMPOSER_SKIP_SCRIPTS

イベント名のコンマ区切りリストを受け付けます。例えば、スクリプト実行をスキップするためのpost-install-cmdがあります。

COMPOSER_NO_AUDIT

1に設定すると、require、update、remove、create-projectコマンドに--no-auditオプションを渡すことと等価になります。

COMPOSER_AUDIT_ABANDONED

Set to ignore, report or fail to override the policy.abandoned.audit config option. Has no effect when policy.abandoned is set to false in composer.json.

COMPOSER_POLICY

Main policy switch. Set to 0 to disable all policy enforcement on updates and audit, or 1 to enable it. Setting this to 1 will use the policy configuration in the composer.json. If you want to override the config value, use composer config policy 1 instead.

When set to 0, all per-list overrides below are ignored — the whole policy config is short-circuited to disabled.

COMPOSER_NO_BLOCKING

If set to 1, it is the equivalent of passing the --no-blocking option to a require, update, remove, install, or create-project command. This disables all policy blocking during this command. It overrides the block config option for each configured policy e.g. policy.advisories.block.

COMPOSER_NO_SECURITY_BLOCKING

非推奨であり、COMPOSER_NO_BLOCKINGを代用してください。

If set to 1, it is the equivalent of passing the --no-security-blocking option to a require, update, remove, install, or create-project command. This allows installing packages with security advisories or that are abandoned. It overrides the config option policy.advisories.block.

COMPOSER_POLICY_ADVISORIES_BLOCK

If set to 1, enables blocking of packages with security advisories during dependency resolution (equivalent to setting policy.advisories.block to true). If set to 0, disables blocking.

COMPOSER_POLICY_MALWARE_BLOCK

If set to 1, enables blocking of packages flagged as malware during dependency resolution (equivalent to setting policy.malware.block to true). If set to 0, disables blocking.

COMPOSER_POLICY_ABANDONED_BLOCK

If set to 1, enables blocking of abandoned packages during dependency resolution (equivalent to setting policy.abandoned.block to true). If set to 0, disables blocking.

Takes precedence over the legacy COMPOSER_SECURITY_BLOCKING_ABANDONED when both are set.

COMPOSER_SECURITY_BLOCKING_ABANDONED

非推奨であり、COMPOSER_POLICY_ABANDONED_BLOCKを代用してください。

If set to 1, enables blocking of abandoned packages during dependency resolution (equivalent to setting audit.block-abandoned config to true). If set to 0, disables blocking of abandoned packages. It overrides the config option audit.block-abandoned.

Keyboard shortcuts

Composer