civicrm/cli-tools

维护者

详细信息

github.com/civicrm/civicrm-cli-tools

源代码

问题

安装次数: 6,622

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 3

分支: 1

开放问题: 0

v2024.09.19.1726740854 2024-09-19 10:14 UTC

Requires

AGPL-3.0 0beab5d5fcd97b4a2e57a0b7666a0e6abfe87d8c

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

This package is auto-updated.

Last update: 2024-09-19 10:15:08 UTC

README

一组针对CiviCRM的特定命令行工具。具体包括

  • cv：通用管理工具/瑞士军刀
  • civistrings：扫描源代码中的可翻译字符串
  • civix：生成扩展
  • coworker：执行后台任务

此工具针对使用composer部署（尤其是Drupal 9/10）的网站构建者。它支持基于composer require、composer update和vendor-bin的工作流程。

用法

要将这些工具添加到现有的composer构建（例如Drupal 9/10网站）中，请运行

composer require civicrm/cli-tools

这会将CiviCRM CLI工具添加到composer的vendor/bin文件夹中。

您可以通过composer exec或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

深入了解

  • 这类似于civicrm-buildkit的一个子集。它省略了通用开发工具（phpunit）、CMS构建工具（drush、wp）、标准运行环境（min、max）和自动构建网站（drupal-clean、wp-demo等）。这仅是您希望添加到D9/D10网站上的CiviCRM特定内容。
  • 这里的桥梁有3个简单的部分
    1. 通过composer-downloads-plugin下载每个可执行文件（例如，extern/cv.phar）。
    2. 添加一个占位符脚本（例如，bin/cv）。
    3. 将占位符（bin/cv）注册为与composer的vendor/bin/一起使用。
  • 这种布局应该能够利用composer的平台特定连接（例如Windows .bat文件）。