CheatPress

Composer PHP package manager

Version 2.10 · source

Composer, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Composer, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Composer, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Composer, A5, light preview Light · A5 148 × 210 mm · PDF Composer, A5, dark preview Dark · A5 148 × 210 mm · PDF Composer, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Composer, A4, light preview Light · A4 210 × 297 mm · PDF Composer, A4, dark preview Dark · A4 210 × 297 mm · PDF Composer, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Composer, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Composer, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Composer, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Composer, A3, light preview Light · A3 297 × 420 mm · PDF Composer, A3, dark preview Dark · A3 297 × 420 mm · PDF Composer, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Composer, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Composer, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Composer, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Composer, Letter, light preview Light · Letter 8.5 × 11 in · PDF Composer, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Composer, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Composer, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Composer, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Composer, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

composer init
Create composer.json
composer require <vendor/pkg>
Add a dependency
composer install
Install from the lock file
composer update
Upgrade within constraints
composer remove <vendor/pkg>
Drop a dependency
composer show
List installed packages
composer outdated
See newer versions
composer dump-autoload
Rebuild the autoloader

Concepts

  1. composer.json your constraints
  2. composer.lock exact versions
  3. vendor/ packages + autoload.php

Project

composer init
Create composer.json interactively
composer create-project <vendor/pkg> <dir>
Start a new project from a package
composer validate
Check composer.json is valid
composer validate --strict
Treat warnings as errors
composer config <key> <value>
Set a config value
composer config --list
Show the effective config
composer config --global <key> <value>
Set a user-wide config value
composer bump
Raise constraints to installed versions
composer diagnose
Check system and network problems
composer status
Show locally changed packages

Install & remove

composer install
Install exactly what the lock says
composer install --no-dev
Skip require-dev packages
composer install --prefer-dist
Download archives, not clones
composer install -o
Optimize the autoloader
composer install -a
Authoritative classmap (production)
Skips filesystem lookups for missing classes, so classes created later are not found.
composer install --dry-run
Show what would happen
composer reinstall <vendor/pkg>
Reinstall a package from scratch
composer remove <vendor/pkg>
Remove a dependency
composer remove --unused
Remove packages nothing needs
composer clear-cache
Empty the download cache

Require & update

composer require <vendor/pkg>
Add a package and install it
composer require <vendor/pkg>:<constraint>
Add with a version constraint
e.g. composer require "monolog/monolog:^3.0" (quote the constraint).
composer require --dev <vendor/pkg>
Add a dev-only dependency
composer require --no-update <vendor/pkg>
Edit composer.json only
composer update
Update everything within constraints
composer update <vendor/pkg>
Update only one package
composer update <vendor/pkg> -W
Also update its dependencies
composer update --dry-run
Preview an update
composer update --lock
Refresh lock hashes, no upgrades
composer update --prefer-lowest --prefer-stable
Test against the lowest versions
composer update -m
Prefer minimal changes
composer update --no-dev
Update without dev packages

Inspect

composer show
List installed packages
composer show <vendor/pkg>
Details of one package
composer show -t
Dependency tree
composer show --self
Show the root package
composer show -P
Show install paths
composer outdated
List packages with newer versions
composer outdated -D
Only direct dependencies
composer outdated -M
Only major updates
composer outdated -m
Only minor updates
composer why <vendor/pkg>
Why is this installed?
composer why-not <vendor/pkg> <version>
Why can't this version be installed?
composer search <text>
Search Packagist
composer browse <vendor/pkg>
Open the package page or repo
composer licenses
List licenses of dependencies
composer check-platform-reqs
Check PHP and extension needs

Autoload & scripts

composer dump-autoload
Regenerate the autoloader
composer dump-autoload -o
Generate an optimized classmap
composer dump-autoload -a
Authoritative classmap
composer dump-autoload --no-dev
Autoload without dev classes
composer run-script <name>
Run a script from composer.json
composer <name>
Shortcut for run-script
Works unless the name clashes with a built-in command.
composer run-script -l
List available scripts
composer run-script <name> -- <args>
Pass arguments to a script
composer exec <bin>
Run a binary from vendor/bin
composer install --no-scripts
Skip event scripts

Security & audit

composer audit
Check for known vulnerabilities
composer audit --locked
Audit the lock file only
composer audit -f json
Machine-readable audit output
composer audit --no-dev
Ignore dev dependencies
composer fund
Show how to fund dependencies

Global & options

composer global require <vendor/pkg>
Install a tool for your user
composer global update
Update global tools
composer self-update
Update Composer itself
composer self-update --rollback
Go back to the previous Composer
composer -d <dir> <command>
Run in another directory
composer -n <command>
Never ask questions (CI)
composer -v / -vv / -vvv
More output
composer -q <command>
Suppress output
composer --no-plugins <command>
Disable plugins
composer --ignore-platform-reqs install
Ignore PHP/extension checks
Only a workaround; the code may still fail at runtime.
composer --version
Show the Composer version
composer help <command>
Help for a command
composer list
List all commands

Recipes

New project with a dev tool
composer initcomposer require monolog/monologcomposer require --dev phpunit/phpunitvendor/bin/phpunit
Production deploy
composer install --no-dev -o --no-interaction# or: -a for an authoritative classmap
Careful dependency upgrade
composer outdated -Dcomposer update <vendor/pkg> --dry-runcomposer update <vendor/pkg>composer audit
Find out why a version is blocked
composer why <vendor/pkg>composer why-not <vendor/pkg> <version>composer update <vendor/pkg> -W