mglaman / drupalorg-cli
Command line interface for interacting with Drupal.org
Installs: 1 711
Dependents: 1
Suggesters: 0
Security: 0
Stars: 127
Watchers: 4
Forks: 31
Open Issues: 48
Requires
- php: ^8.1
- composer-runtime-api: ^2.0.0
- ext-dom: *
- ext-json: *
- consolidation/self-update: ^2.0
- czproject/git-php: ^4.1
- dg/rss-php: ^1.2
- doctrine/cache: ^2.2
- guzzlehttp/guzzle: ^6.1 || ^7.3
- jolicode/jolinotif: ^2.3
- kevinrob/guzzle-cache-middleware: ^4
- psr/log: ^2.0
- symfony/cache: ^5.0 || ^6.0
- symfony/console: ^5.0 || ^6.0
- symfony/process: ^5.0 || ^6.0
Requires (Dev)
- phpstan/extension-installer: ^1.0
- phpstan/phpstan: ^1.0.0
- phpstan/phpstan-deprecation-rules: ^1.0.0
- phpstan/phpstan-strict-rules: ^1.0.0
- phpstan/phpstan-symfony: ^1.0.0
- phpunit/phpunit: ^10.1
- squizlabs/php_codesniffer: ^3.5
- dev-main
- 0.5.1
- 0.5.0
- 0.4.1
- 0.4.0
- 0.3.3
- 0.3.2
- 0.3.1
- 0.3.0
- v0.2.0
- v0.1.1
- v0.1.0
- v0.0.9
- v0.0.8
- v0.0.7
- v0.0.6
- v0.0.5
- v0.0.4
- v0.0.3
- v0.0.2
- v0.0.1
- dev-dependabot/composer/phpunit/phpunit-10.3.4
- dev-dependabot/github_actions/actions/checkout-4
- dev-dependabot/composer/symfony/process-6.3.4
- dev-dependabot/composer/symfony/console-6.3.4
- dev-dependabot/composer/phpstan/extension-installer-1.3.1
- dev-dependabot/composer/phpstan/phpstan-symfony-1.3.2
- dev-remove-ppv
- dev-gh-48
- dev-hackathon
- dev-mrn-change-records
- dev-phar
- dev-travis
This package is auto-updated.
Last update: 2024-10-18 11:35:31 UTC
README
A command line tool for interfacing with Drupal.org. Uses the Drupal.org REST API.
Requirements
- PHP 8.1 or higher, with cURL support
- Git - Currently required to apply and create patches. Very useful for contributing patches back to an issue.
Installation
Installing manually
-
Download the
drupalorg.phar
file from the latest release. -
Rename the file to
drupalorg
, ensure it is executable, and move it into a directory in your PATH (useecho $PATH
to see your options). -
Run
drupalorg
and verify you can see the list of available commands.
Installing via Composer (deprecated)
Use the following command to install the command line tool via Composer:
composer global require mglaman/drupalorg-cli
Installing (Bash) completion
drupalorg
comes with completion support for all commands, excluding options.
To activate it, either source the completion file or add it to the system-wide completion directory, normally /etc/bash_completion.d/
.
In your .bashrc
(or .profile
) add
source [...]/vendor/mglaman/drupalorg-cli/drupalorg-cli-completion.sh
Updating
Automatic updating is not yet supported. You will need to manually download new releases.
Usage
Use the 'list' command to see available commands.
drupalorg list
Commands
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
Getting Started
Working with project issues
If you want to use this to generate patches that you can contribute back to a Drupal project, it's best to work within a cloned repo of that project. To get instructions for cloning a project's repo, visit the "Version Control" tab on the project page.
From within the directory of the project we're working on:
drupalorg issue:apply [issue number]
- Create a new branch for the given issue, apply the latest patch on the issue to the new branch, then commit the changes locally.drupalorg issue:patch [issue number]
- Create a new patch for the given issue from the changes committed locally.
Contributing
Installing and running from source
- Clone the repository
- In the drupalorg-cli directory, run
composer install
- Run the script with
./drupalorg