Download the PHP package mglaman/drupalorg-cli without Composer
On this page you can find all versions of the php package mglaman/drupalorg-cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mglaman/drupalorg-cli
More information about mglaman/drupalorg-cli
Files in mglaman/drupalorg-cli
Package drupalorg-cli
Short Description Command line interface for interacting with Drupal.org
License GPL-2.0-or-later
Informations about the package drupalorg-cli
Drupal.org CLI
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.pharfile from the latest release. -
Rename the file to
drupalorg, ensure it is executable, and move it into a directory in your PATH (useecho $PATHto see your options). - Run
drupalorgand 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
Installing (Zsh) completion
drupalorg comes with namespace-aware completion out of the box. If jq is installed, the Zsh completion script upgrades itself to use drupalorg list --format=json once per shell session and can complete:
- commands and namespace-prefixed commands
- documented long and short options (i.e. flags)
- command aliases such as
isandpi - positional argument placeholders such as
<nid>
In those placeholders, angle brackets mean the argument is required, and square brackets mean it is optional. For example, <nid> is required and [nid] is optional.
Without jq, the script falls back to the original command and namespace completion behavior.
Copy the Zsh completion file to ~/.zsh/completions/_drupalorg:
In your ~/.zshrc add (if not already present):
Restart your shell or run source ~/.zshrc.
Updating
Automatic updating is not yet supported. You will need to manually download new releases.
Usage
Use the 'list' command to see available commands.
Commands
`
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
All versions of drupalorg-cli with dependencies
ext-dom Version *
ext-json Version *
composer-runtime-api Version ^2.0.0
caseyamcl/guzzle_retry_middleware Version ^2.13
consolidation/self-update Version ^3.1
czproject/git-php Version ^4.1
dg/rss-php Version ^1.2
guzzlehttp/guzzle Version ^6.1 || ^7.3
jolicode/jolinotif Version ^2.3
mcp/sdk Version ^0.5
psr/log Version ^3.0
symfony/console Version ^6.0 || ^7.0
symfony/process Version ^6.0 || ^7.0