W3cubDocs

/Ansible

community.general.composer module – Dependency Manager for PHP

Note

This module is part of the community.general collection (version 10.7.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.composer.

Synopsis

  • Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it installs them in your project for you.

Requirements

The below requirements are needed on the host that executes this module.

  • php
  • composer installed in bin path (recommended /usr/local/bin) or specified in composer_executable

Parameters

Parameter

Comments

apcu_autoloader

boolean

Uses APCu to cache found/not-found classes.

Choices:

  • false ← (default)
  • true

arguments

string

Composer arguments like required package, version and so on.

Default: ""

classmap_authoritative

boolean

Autoload classes from classmap only.

Implicitly enable optimize_autoloader.

Recommended especially for production, but can take a bit of time to run.

Choices:

  • false ← (default)
  • true

command

string

Composer command like install, update and so on.

Default: "install"

composer_executable

path

added in community.general 3.2.0

Path to composer executable on the remote host, if composer is not in PATH or a custom composer is needed.

executable

aliases: php_path

path

Path to PHP executable on the remote host, if PHP is not in PATH.

global_command

boolean

Runs the specified command globally.

Choices:

  • false ← (default)
  • true

ignore_platform_reqs

boolean

Ignore php, hhvm, lib-* and ext-* requirements and force the installation even if the local machine does not fulfill these.

Choices:

  • false ← (default)
  • true

no_dev

boolean

Disables installation of require-dev packages (see --no-dev).

Choices:

  • false
  • true ← (default)

no_plugins

boolean

Disables all plugins (see --no-plugins).

Choices:

  • false ← (default)
  • true

no_scripts

boolean

Skips the execution of all scripts defined in composer.json (see --no-scripts).

Choices:

  • false ← (default)
  • true

optimize_autoloader

boolean

Optimize autoloader during autoloader dump (see --optimize-autoloader).

Convert PSR-0/4 autoloading to classmap to get a faster autoloader.

Recommended especially for production, but can take a bit of time to run.

Choices:

  • false
  • true ← (default)

prefer_dist

boolean

Forces installation from package dist even for dev versions (see --prefer-dist).

Choices:

  • false ← (default)
  • true

prefer_source

boolean

Forces installation from package sources when possible (see --prefer-source).

Choices:

  • false ← (default)
  • true

working_dir

path

Directory of your project (see --working-dir). This is required when the command is not run globally.

This is ignored if global_command=true.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • Default options that are always appended in each execution are --no-ansi, --no-interaction and --no-progress if available.
  • We received reports about issues on macOS if composer was installed by Homebrew. Please use the official install method to avoid issues.

Examples

- name: Download and installs all libs and dependencies outlined in the /path/to/project/composer.lock
  community.general.composer:
    command: install
    working_dir: /path/to/project

- name: Install a new package
  community.general.composer:
    command: require
    arguments: my/package
    working_dir: /path/to/project

- name: Clone and install a project with all dependencies
  community.general.composer:
    command: create-project
    arguments: package/package /path/to/project ~1.0
    working_dir: /path/to/project
    prefer_dist: true

- name: Install a package globally
  community.general.composer:
    command: require
    global_command: true
    arguments: my/package

Authors

  • Dimitrios Tydeas Mengidis (@dmtrs)
  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/composer_module.html