PHPackages                             civicrm/civix - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. civicrm/civix

ActiveLibrary[CLI &amp; Console](/categories/cli)

civicrm/civix
=============

CiviCRM Extension CLI

v26.02.0(3mo ago)592.2k59[8 PRs](https://github.com/totten/civix/pulls)AGPL-3.0PHPPHP &gt;=7.4.0CI passing

Since Oct 7Pushed 2mo ago11 watchersCompare

[ Source](https://github.com/totten/civix)[ Packagist](https://packagist.org/packages/civicrm/civix)[ Docs](https://github.com/totten/civix)[ RSS](/packages/civicrm-civix/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (13)Versions (104)Used By (0)

civix
=====

[](#civix)

Civix is a command-line tool for building CiviCRM extensions. It is distributed as part of [CiviCRM-Buildkit](https://github.com/civicrm/civicrm-buildkit).

Requirements
------------

[](#requirements)

- PHP 7.4+
- CiviCRM 5.x (*Recommended: any release from the prior 12 months*)
- (For MAMP, WAMP, XAMPP, etc) PHP command-line configuration ()
- (For CentOS/RHEL) Compatible version of libxml2 ([\#19](https://github.com/totten/civix/issues/19))

Download
--------

[](#download)

`civix` is distributed in PHAR format, which is a portable executable file (for PHP). It should run on most Unix-like systems where PHP is installed. Here are three quick ways to download it:

- Download [the latest release of `civix.phar`](https://download.civicrm.org/civix/civix.phar) (*[SHA256](https://download.civicrm.org/civix/civix.SHA256SUMS), [GPG](https://download.civicrm.org/civix/civix.phar.asc)*) and put it in the PATH. For example:

    ```
    sudo curl -LsS https://download.civicrm.org/civix/civix.phar -o /usr/local/bin/civix
    sudo chmod +x /usr/local/bin/civix
    ```

    (*Learn more: [Install `civix.phar` as system-wide tool (Linux/BSD/macOS)](doc/download.md#phar-unix)*)
- Or... add `civix` and other CiviCRM tools to a composer project (Drupal 9/10/11)

    ```
    composer require civicrm/cli-tools
    ```

    (*Learn more: [Install `civix.phar` as project tool (composer)](doc/download.md#phar-composer)*)
- Or... use [phar.io's `phive` installer](https://phar.io/) to download, validate, and cache the `civix.phar` file.

    ```
    phive install totten/civix
    ```

    (*Learn more: [Install `civix.phar` as project tool (phive)](doc/download.md#phar-phive)*)

There are several more options for downloading `civix`. See also:

- [Download URLs for alternate versions](doc/download.md#urls)
- [Comparison of install options](doc/download.md#comparison)
- Install `civix` as a system-wide/standalone tool
    - [Install `civix.phar` (binary) as system-wide tool (Linux/BSD/macOS)](doc/download.md#phar-unix)
    - [Install `civix.git` (source) as standalone project (Linux/BSD/macOS)](doc/download.md#src-unix)
    - [Install `civix.git` (source) as standalone project (Windows)](doc/download.md#src-win)
- Install `civix` as a tool within another project
    - [Install `civix.phar` (binary) as project tool (composer)](doc/download.md#phar-composer)
    - [Install `civix.phar` (binary) as project tool (phive)](doc/download.md#phar-phive)
    - [Install `civix.git` (source) as project tool (composer)](doc/download.md#src-composer)

Documentation
-------------

[](#documentation)

The [CiviCRM Developer Guide](https://docs.civicrm.org/dev/en/latest/) includes [tutorials for building extensions](https://docs.civicrm.org/dev/en/latest/extensions/civix/)

For reference documentation, civix supports a "--help" option. For example, to get reference materials about the "generate:page" command, run:

```
civix generate:page --help
```

Development
-----------

[](#development)

If you are developing updates for `civix.git`, then see [doc/develop.md](doc/develop.md). It discusses PHAR compilation, unit tests, and similar processes.

###  Health Score

60

—

FairBetter than 99% of packages

Maintenance83

Actively maintained with recent releases

Popularity35

Limited adoption so far

Community30

Small or concentrated contributor base

Maturity80

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 82% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~53 days

Recently: every ~32 days

Total

86

Last Release

94d ago

Major Versions

v21.04.1 → v22.02.02022-02-14

v22.10.2 → v23.02.02023-02-23

v23.12.2 → v24.09.02024-09-18

v24.12.0 → v25.01.02025-01-21

v25.12.0 → v26.01.02026-01-31

PHP version history (5 changes)v13.10.0PHP &gt;=5.3.3

v20.07.1PHP &gt;=7.1.3

v22.05.2PHP &gt;=7.2.0

v23.07.1PHP &gt;=7.3.0

v25.10.1PHP &gt;=7.4.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1336047?v=4)[Tim Otten](/maintainers/totten)[@totten](https://github.com/totten)

---

Top Contributors

[![totten](https://avatars.githubusercontent.com/u/1336047?v=4)](https://github.com/totten "totten (1091 commits)")[![colemanw](https://avatars.githubusercontent.com/u/2874912?v=4)](https://github.com/colemanw "colemanw (71 commits)")[![eileenmcnaughton](https://avatars.githubusercontent.com/u/336308?v=4)](https://github.com/eileenmcnaughton "eileenmcnaughton (44 commits)")[![pbatroff](https://avatars.githubusercontent.com/u/22370179?v=4)](https://github.com/pbatroff "pbatroff (29 commits)")[![michaelmcandrew](https://avatars.githubusercontent.com/u/209967?v=4)](https://github.com/michaelmcandrew "michaelmcandrew (23 commits)")[![seamuslee001](https://avatars.githubusercontent.com/u/6799125?v=4)](https://github.com/seamuslee001 "seamuslee001 (16 commits)")[![semseysandor](https://avatars.githubusercontent.com/u/51154903?v=4)](https://github.com/semseysandor "semseysandor (8 commits)")[![demeritcowboy](https://avatars.githubusercontent.com/u/2967821?v=4)](https://github.com/demeritcowboy "demeritcowboy (7 commits)")[![universalhandle](https://avatars.githubusercontent.com/u/871819?v=4)](https://github.com/universalhandle "universalhandle (7 commits)")[![mattwire](https://avatars.githubusercontent.com/u/2052161?v=4)](https://github.com/mattwire "mattwire (5 commits)")[![ErichBSchulz](https://avatars.githubusercontent.com/u/951298?v=4)](https://github.com/ErichBSchulz "ErichBSchulz (3 commits)")[![xurizaemon](https://avatars.githubusercontent.com/u/105608?v=4)](https://github.com/xurizaemon "xurizaemon (3 commits)")[![kewljuice](https://avatars.githubusercontent.com/u/3306776?v=4)](https://github.com/kewljuice "kewljuice (3 commits)")[![mlutfy](https://avatars.githubusercontent.com/u/254741?v=4)](https://github.com/mlutfy "mlutfy (2 commits)")[![aydun](https://avatars.githubusercontent.com/u/2730045?v=4)](https://github.com/aydun "aydun (2 commits)")[![seancolsen](https://avatars.githubusercontent.com/u/42411?v=4)](https://github.com/seancolsen "seancolsen (2 commits)")[![tttp](https://avatars.githubusercontent.com/u/128426?v=4)](https://github.com/tttp "tttp (2 commits)")[![ojhaujjwal](https://avatars.githubusercontent.com/u/4995501?v=4)](https://github.com/ojhaujjwal "ojhaujjwal (1 commits)")[![jrobens](https://avatars.githubusercontent.com/u/169989?v=4)](https://github.com/jrobens "jrobens (1 commits)")[![pfigel](https://avatars.githubusercontent.com/u/277794?v=4)](https://github.com/pfigel "pfigel (1 commits)")

### Embed Badge

![Health badge](/badges/civicrm-civix/health.svg)

```
[![Health](https://phpackages.com/badges/civicrm-civix/health.svg)](https://phpackages.com/packages/civicrm-civix)
```

###  Alternatives

[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[humbug/php-scoper

Prefixes all PHP namespaces in a file or directory.

7963.0M35](/packages/humbug-php-scoper)[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6939.5M343](/packages/drupal-core-recommended)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
