civicrm/cli-tools

Maintainers

Package info

github.com/civicrm/civicrm-cli-tools

pkg:composer/civicrm/cli-tools

Statistics

Installs: 43 847

Dependents: 0

Suggesters: 0

Stars: 3

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v2026.03.20.1774037652 2026-03-20 20:14 UTC

Requires

AGPL-3.0 00a6b1cedfdd7ae3db53ec7c0b1d4d0b6fff7aa0

  • Tim Otten <totten.woop@civicrm.org>

This package is auto-updated.

Last update: 2026-05-20 20:47:24 UTC

README

A bundle of CiviCRM command-line tools. This specifically includes:

  • cv: General purpose administration / Swiss Army knife
  • civistrings: Scan source-code for translatable strings
  • civix: Generate extensions
  • coworker: Execute background jobs

This is intended for site-builders who have composer-based deployments (esp Drupal 9/10). It supports workflows based on composer require, composer update, and vendor-bin.

Usage

To add these tools to an existing composer build (e.g. Drupal 9/10 site), run:

composer require civicrm/cli-tools

This adds CiviCRM CLI tools to composer's vendor/bin folder.

You can call commands through composer exec or vendor/bin:

## Example 1: Call cv through `composer exec`
composer exec cv api4 Contact.get +l 1

## Example 2: Call cv through `./vendor/bin`
./vendor/bin/cv api4 Contact.get +l 1

## Example 3: Add cv your PATH
PATH="/path/to/vendor/bin:$PATH"
cv api4 Contact.get +l 1

In depth

  • This is like a subset of civicrm-buildkit. It omits general development tools (phpunit), CMS-building tools (drush, wp), standard runtime environments (min, max), and autobuild sites (drupal-clean, wp-demo, etc). This is only the Civi-specific stuff that you would want to add on top of D9/D10 sites.
  • The bridge here has 3 simple pieces:
    1. Download each executable via composer-downloads-plugin (e.g. extern/cv.phar).
    2. Add a stub script (e.g. bin/cv)
    3. Register the stub (bin/cv) for use with composer's vendor/bin/.
  • This layout should be able to leverage composer's platform-specific wiring (e.g. Windows .bat files).

Maintenance

This project is derived from civicrm-buildkit.git:phars.json. Whenever there's a relevant update to phars.json, we should also update civicrm-cli-tools.

For a maintainer of civicrm/civicrm-cli-tools.git, you can follow these steps:

git clone git@github.com:civicrm/civicrm-cli-tools.git
cd civicrm-cli-tools
./scripts/update
git push <FIXME>

Note the output of ./script/update. It will include details about how to push the update.