mglaman/drupalorg-cli

与 Drupal.org 交互的命令行界面


README

Latest Stable Version Total Downloads Latest Unstable Version License

用于与 Drupal.org 交互的命令行工具。使用 Drupal.org REST API。

需求

  • PHP 8.1 或更高版本,支持 cURL
  • Git - 目前需要用于应用和创建补丁。对于将补丁贡献回问题非常有用。

安装

手动安装

  1. 最新版本 下载 drupalorg.phar 文件。

  2. 将文件重命名为 drupalorg,确保它是可执行的,并将其移动到您的 PATH 目录中(使用 echo $PATH 查看选项)。

  3. 运行 drupalorg 并验证您是否可以看到可用的命令列表。

通过 Composer 安装(已弃用)

使用以下命令通过 Composer 安装命令行工具

composer global require mglaman/drupalorg-cli

安装(Bash)完成

drupalorg 为所有命令提供完成支持,但不包括选项。

要激活它,可以源代码完成文件或将其添加到系统范围的完成目录中,通常是 /etc/bash_completion.d/

在您的 .bashrc(或 .profile)中添加

source [...]/vendor/mglaman/drupalorg-cli/drupalorg-cli-completion.sh

更新

自动更新尚未支持。您需要手动下载新版本。

使用方法

使用 'list' 命令查看可用的命令。

drupalorg list

命令

Available commands:
  help                                 Displays help for a command
  list                                 Lists commands
 cache
  cache:clear (cc)                     Clears caches
 ci
 drupalci
  drupalci:list (ci:l)                 Lists test results for an issue
  drupalci:watch (ci:w)                Watches a Drupal CI job
 issue
  issue:apply                          Applies the latest patch from an issue.
  issue:branch                         Creates a branch for the issue.
  issue:interdiff                      Generate an interdiff for the issue from local changes.
  issue:link                           Opens an issue
  issue:patch                          Generate a patch for the issue from committed local changes.
 maintainer
  maintainer:issues (mi)               Lists issues for a user, based on maintainer.
  maintainer:release-notes (rn, mrn)   Generate release notes.
 project
  project:issues (pi)                  Lists issues for a project.
  project:kanban                       Opens project kanban
  project:link                         Opens project page
  project:release-notes (prn)          View release notes for a release
  project:releases                     Lists available releases
 tci
 travisci
  travisci:list (tci:l)                Lists Travis Ci builds for a Drupal project
  travisci:watch (tci:w)               Watches a Travis CI job

入门

处理项目问题

如果您想使用它生成可以贡献给 Drupal 项目的补丁,最好在已克隆的项目仓库内工作。要获取克隆项目仓库的说明,请访问项目页面上的“版本控制”标签页。

在我们要工作的项目目录中

  • drupalorg issue:apply [问题编号] - 为给定的问题创建新的分支,将问题的最新补丁应用到新分支上,然后在本地提交更改。
  • drupalorg issue:patch [问题编号] - 从本地提交的更改创建给定问题的新的补丁。

贡献

从源代码安装和运行

  1. 克隆仓库
  2. 在 drupalorg-cli 目录中,运行 composer install
  3. 使用 ./drupalorg 运行脚本