README

Civix 是一个用于构建 CiviCRM 扩展的命令行工具。它是作为 CiviCRM-Buildkit 的一部分进行分发的。

需求

PHP 7.3+
CiviCRM 5.x （推荐：过去 12 个月内的任何版本）
（对于 MAMP、WAMP、XAMPP 等）PHP 命令行配置（http://wiki.civicrm.org/confluence/display/CRMDOC/Setup+Command-Line+PHP）
（对于 CentOS/RHEL）兼容版本的 libxml2（《#19》）

civix 以 PHAR 格式分发，这是一个便携式可执行文件（适用于 PHP）。它应该在大多数已安装 PHP 的类 Unix 系统上运行。以下是三种快速下载方法：

下载 civix.phar 的最新版本（SHA256, GPG）并将其放入 PATH。例如
```
sudo curl -LsS https://download.civicrm.org/civix/civix.phar -o /usr/local/bin/civix
sudo chmod +x /usr/local/bin/civix
```
（了解更多信息：将 civix.phar 安装为系统范围内的工具（Linux/BSD/macOS））
或者... 将 civix 和其他 CiviCRM 工具添加到 composer 项目中（Drupal 9/10/11）
```
composer require civicrm/cli-tools
```
（了解更多信息：将 civix.phar 安装为项目工具（composer））
或者... 使用 phar.io 的 phive 安装程序下载、验证和缓存 civix.phar 文件。
```
phive install totten/civix
```
（了解更多信息：将 civix.phar 安装为项目工具（phive））

还有更多下载 civix 的选项。另请参阅

对于参考文档，civix 支持一个 “--help” 选项。例如，要获取有关 “generate:page” 命令的参考材料，请运行

civix generate:page --help

如果您正在为 civix.git 开发更新，请参阅 doc/develop.md。它讨论了 PHAR 编译、单元测试等类似过程。