civicrm / civix
CiviCRM Extension CLI
Installs: 1 997
Dependents: 0
Suggesters: 0
Security: 0
Stars: 57
Watchers: 13
Forks: 56
Open Issues: 27
Requires
- php: >=7.3.0
- civicrm/composer-compile-plugin: ~0.18
- civicrm/composer-downloads-plugin: ~2.1|^3
- civicrm/cv-lib: ~0.3.59
- civicrm/php-array-doc: ~0.1.7
- symfony/console: ^4|^5
- symfony/filesystem: ^4|^5
- symfony/process: ^4|^5
- symfony/templating: ^4|^5
- symfony/var-dumper: ^4|^5
- symfony/var-exporter: ^4.4|^5
- totten/license-data: dev-master
- totten/process-helper: ^1.0.1
- webmozart/glob: ^4.7
- dev-master
- v24.12.0
- v24.11.0
- v24.09.2
- v24.09.1
- v24.09.0
- v23.12.2
- v23.12.1
- v23.12.0
- v23.08.2
- v23.08.1
- v23.08.0
- v23.07.1
- v23.07.0
- v23.03.0
- v23.02.1
- v23.02.0
- v22.10.2
- v22.10.1
- v22.10.0
- v22.08.0
- v22.07.2
- v22.07.1
- v22.07.0
- v22.06.2
- v22.06.1
- v22.06.0
- v22.05.5
- v22.05.4
- v22.05.3
- v22.05.2
- v22.05.1
- v22.05.0
- v22.02.0
- v21.04.1
- v21.04.0
- v20.09.0
- v20.07.1
- v20.07.0
- v20.06.0
- v20.02.0
- v19.11.0
- v19.10.0
- v19.08.0
- v19.06.1
- v19.06.0
- v19.02.0
- v18.12.0
- v18.03.0
- v18.02.0
- v17.10.5
- v17.10.4
- v17.10.3
- v17.10.2
- v17.10.1
- v17.10.0
- v17.08.1
- v17.08.0
- v17.04.0
- v17.02.0
- v17.01.4
- v17.01.3
- v17.01.2
- v17.01.1
- v17.01.0
- v16.12.0
- v16.10.1
- v16.10.0
- v16.03.2
- v16.03.1
- v16.03.0
- v16.02.1
- v16.02.0
- v15.04.1
- v14.09.1
- v14.01.0
- v13.10.0
- dev-master-civimix
- dev-master-upg-b
- dev-master-auto-sql-dynamicy
- dev-master-auto-sql-staticy
- dev-master-auto-sql-2
- dev-master-relpath
- dev-civi-naming
- dev-master-releaser-doc
- dev-master-example
- dev-restore-lifecycle
- dev-unknown-schemabuilder
- dev-master-mixin-2
- dev-master-upg-sql
- dev-master-array-tpl
This package is auto-updated.
Last update: 2024-12-17 06:26:37 UTC
README
Civix is a command-line tool for building CiviCRM extensions. It is distributed as part of CiviCRM-Buildkit.
Requirements
- PHP 7.3+
- CiviCRM 5.x (Recommended: any release from the prior 12 months)
- (For MAMP, WAMP, XAMPP, etc) PHP command-line configuration (http://wiki.civicrm.org/confluence/display/CRMDOC/Setup+Command-Line+PHP)
- (For CentOS/RHEL) Compatible version of libxml2 (#19)
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(SHA256, GPG) 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.pharas system-wide tool (Linux/BSD/macOS)) -
Or... add
civixand other CiviCRM tools to a composer project (Drupal 9/10/11)composer require civicrm/cli-tools
(Learn more: Install
civix.pharas project tool (composer)) -
Or... use phar.io's
phiveinstaller to download, validate, and cache thecivix.pharfile.phive install totten/civix
(Learn more: Install
civix.pharas project tool (phive))
There are several more options for downloading civix. See also:
- Download URLs for alternate versions
- Comparison of install options
- Install
civixas a system-wide/standalone tool - Install
civixas a tool within another project
Documentation
The CiviCRM Developer Guide includes tutorials for building extensions
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
If you are developing updates for civix.git, then see doc/develop.md. It discusses PHAR compilation, unit tests, and similar processes.