{"id":25209569,"url":"https://github.com/backdrop-contrib/backdrop-drush-extension","last_synced_at":"2025-07-01T05:34:50.752Z","repository":{"id":45995659,"uuid":"45898954","full_name":"backdrop-contrib/backdrop-drush-extension","owner":"backdrop-contrib","description":"A set of commands and boot class for Drush and Backdrop CMS.","archived":false,"fork":false,"pushed_at":"2024-04-15T19:14:11.000Z","size":967,"stargazers_count":14,"open_issues_count":47,"forks_count":18,"subscribers_count":18,"default_branch":"1.x-1.x","last_synced_at":"2025-06-10T06:43:08.752Z","etag":null,"topics":["backdrop","cli","drush","php"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/backdrop-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-11-10T08:41:19.000Z","updated_at":"2024-10-26T07:16:55.000Z","dependencies_parsed_at":"2024-04-15T17:09:23.172Z","dependency_job_id":"f4996b3d-1e44-405c-b339-f7e1393c22e0","html_url":"https://github.com/backdrop-contrib/backdrop-drush-extension","commit_stats":{"total_commits":230,"total_committers":18,"mean_commits":"12.777777777777779","dds":"0.15652173913043477","last_synced_commit":"af29e23aa7a428fb28b42923bf6405b01da4fa56"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/backdrop-contrib/backdrop-drush-extension","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fbackdrop-drush-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fbackdrop-drush-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fbackdrop-drush-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fbackdrop-drush-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/backdrop-contrib","download_url":"https://codeload.github.com/backdrop-contrib/backdrop-drush-extension/tar.gz/refs/heads/1.x-1.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backdrop-contrib%2Fbackdrop-drush-extension/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260453550,"owners_count":23011558,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backdrop","cli","drush","php"],"created_at":"2025-02-10T13:17:57.778Z","updated_at":"2025-07-01T05:34:50.730Z","avatar_url":"https://github.com/backdrop-contrib.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Drush Integration for Backdrop CMS\n==================================\n\nThis project allows you to use [Drush 8](https://github.com/drush-ops/drush) with\n[Backdrop CMS](https://backdropcms.org). Drush is a command-line tool for\nmanipulating content management systems.\n\n**This project is deprecated. The [bee](https://github.com/backdrop-contrib/bee)\nproject is the best way to interact with Backdrop via the CLI.** If you use the\nbackdrop-drush extension on your Backdrop projects, PHP 7.4 is recommended, as\ndrush 8 has some issues with PHP 8+. Drush 8 is also scheduled to become\nunsupported when Drupal 7 reaches end-of-life on January 15, 2025.\n\nThis integration is currently capable of executing the following commands:\n\n* `drush dlb backdrop`: Download Backdrop CMS.\n* `drush cc`: Clear individual or all caches in Backdrop.\n* `drush uli`: Generate a one-time login link.\n* `drush upwd`: Update the password for a selected user.\n* `drush st` : Check the status of a Backdrop site; bootstrap, database connection etc.\n* `drush cron`: Run the regular interval commands in hook_cron().\n* `drush updb`: Run database updates through the Backdrop update.php script.\n\n- `drush pml`: Show a list of available extensions (modules and themes).\n- `drush dl`: Download and unpack contrib modules, themes, and layouts.\n- `drush en`: Enable one or more extensions (modules or themes). Enable dependant extensions as well.\n- `drush dis`: Disable one or more extensions (modules or themes). Disable dependant extensions as well.\n- `drush pmu`: Uninstall one or more modules and their dependent modules.\n\n* `drush bcex`: Export a Backdrop site configuration.\n* `drush bcim`: Import Backdrop site configuration.\n* `drush bp`: Generate boilerplate code for developers; *.info and *.module files.\n* `drush sql-*`: MySQL connection commands, such as `sql-cli` or `sql-conf`.\n* `drush scr`: Execute scripts with the Backdrop API.\n* `drush ctl`: List the content types available on the site. (only for backdrush \u003e= 1.1.0)\n\nTo see a full list of available drush commands (not all of which will \nnecessarily work with Backdrop CMS):\n\n* `drush help`\n\nTo get additional information about a specific command\n\n* `drush help \u003ccommand\u003e`\n\nThere are many more commands that Drush may execute, but they need to be updated\nfor use with Backdrop. Although some commands may have worked through Backdrop's\ncompatibility layer, for now any untested (and possibly dangerous) commands are\nnot allowed to be run within a Backdrop installation.\n\nAs an alternative to Drush, you may like to consider using\n[Backdrop Console](https://github.com/backdrop-contrib/b), which has been built\nfrom the ground-up specifically for Backdrop.\n\nInstallation\n------------\n\nThis project requires that you use the \"8.x\" branch of drush\n(https://github.com/drush-ops/drush/tree/8.x). Neither older versions of drush\nnor the new 9.x or master branches will work with this extension.\n\nThere are a number of ways to install the Backdrop drush extension. All of them\nrequire the drush `8.x` upstream. The main two ways are to install globally or\nsite local installs.\n\nThe main advantage to the global install is you install the Backdrop Drush\nExtension once it operates on all your Backdrop sites. The disadvantage is that\nit can effect how drush operates on Drupal sites (sometimes breaking some\ncommands). We try our best to prevent that, but it has been known to happen.\n\nThe main advantage to site local installs is that you will not break your Drupal\nsites or other Backdrop sites. The main disadvantage is you need to install\ndrush proper and backdrop drush once per site.\n\nInstall with Lando\n------------------\n\nI primarily use [Lando](https://docs.devwithlando.io) to do my development and\nLando comes with the Backdrop Drush Extension installed 'out of the box'. I\nrecommend Lando to do local development in general and as a great way to\nisolate dev dependencies and tooling for Backdrop site development.\n\nBy default Lando will install the latest stable release of the Backdrop Drush\nextension, but you can point it at any git tag or commit hash. If you wish to\nlive on the bleeding edge and run the Backdrop Drush extension from source you\ncan use this example\n[.lando.yml](https://github.com/backdrop-contrib/backdrop-drush-extension/wiki/Contributing-code-to-the-Backdrop-drush-extension.)\nfile.\n\nInstall as Site Local\n---------------------\n\nDownload drush proper to your `BACKDROP_ROOT` (the place where your Backdrop\ncode exists. The directory structure should loook something like this:\n\n```bash\n└─ $ ∴ ll\ntotal 84\ndrwxrwxr-x 10 gff gff  4096 Jan 12 13:04 ./             \u003c-- BACKDROP_ROOT\ndrwxrwxr-x  3 gff gff  4096 Jan 12 13:01 ../\ndrwxrwxr-x  9 gff gff  4096 Jan 12 13:03 core/\ndrwxr-xr-x 11 gff gff  4096 Jan 12 13:04 drush/         \u003c-- Drush 8.x\n-rw-rw-r--  1 gff gff   554 Jan 12 13:03 .editorconfig\ndrwxrwxr-x  4 gff gff  4096 Jan 12 14:16 files/\ndrwxrwxr-x  8 gff gff  4096 Jan 12 13:41 .git/\n-rw-rw-r--  1 gff gff   257 Jan 12 13:03 .gitignore\n-rw-rw-r--  1 gff gff  6017 Jan 12 13:03 .htaccess\n-rwxrwxr-x  1 gff gff   578 Jan 12 13:03 index.php*\ndrwxrwxr-x  2 gff gff  4096 Jan 12 13:03 layouts/\ndrwxrwxr-x  3 gff gff  4096 Jan 12 14:21 modules/\n-rw-rw-r--  1 gff gff  3978 Jan 12 13:03 README.md\n```\n\nThen add the Backdrop Drush Extension to the `BACKDROP_ROOT/drush/commands`\ndirectory. Should look something like this:\n\n```bash\n└─ $ ∴ ll\ntotal 40\ndrwxr-xr-x  9 gff gff 4096 Jan 12 13:04 ./      \u003c-- BACKDROP_ROOT/drush/commands\ndrwxr-xr-x 11 gff gff 4096 Jan 12 13:04 ../\ndrwxr-xr-x  6 gff gff 4096 Jan 12 17:36 backdrop/  \u003c-- Backdrop Drush Extension\ndrwxr-xr-x  4 gff gff 4096 Jan 12 13:42 core/\ndrwxr-xr-x  2 gff gff 4096 Jan 12 13:04 make/\ndrwxr-xr-x  4 gff gff 4096 Jan 12 13:04 pm/\ndrwxr-xr-x  2 gff gff 4096 Jan 12 13:04 runserver/\ndrwxr-xr-x  2 gff gff 4096 Jan 12 13:04 sql/\ndrwxr-xr-x  2 gff gff 4096 Jan 12 13:04 user/\n-rw-r--r--  1 gff gff 3049 Jan 12 13:04 xh.drush.inc\n```\n\nInstall Globally\n----------------\n\nIf you are using composer to install drush, you can run the following command to\nrequire the 8.x version:\n\n```bash\ncomposer global require drush/drush:8.x\n```\n\nTo install the Backdrop integration for Drush, clone or download this project\ninto any location that supports Drush commands. The most common location for\ncustom Drush commands such as this is in your user's home directory.\n\n- `mkdir ~/.drush/commands` (This may already exist, if so continue.)\n- `cd ~/.drush/commands`\n  -- Get either the latest head or the latest stable:\n    --- Latest HEAD: `wget https://github.com/backdrop-contrib/backdrop-drush-extension/archive/1.x-0.x.zip`\n    --- Latest Stable: `https://github.com/backdrop-contrib/backdrop-drush-extension/releases/latest`\n- `unzip master.zip -d backdrop`\n- Clear the drush cache\n  -- `drush cc drush`\n\nNow switch to a Backdrop site's directory and try a command! `drush cron` works\nwell.\n\nUsage\n-----\n\nUse Drush as you would normally with a Drupal website.\n\nLicense\n-------\n\nThis project is GPL v2 software. See the LICENSE.txt file in this directory for\ncomplete text.\n\nMaintainers\n-----------\n\n- Geoff St. Pierre [@serundeputy](https://github.com/serundeputy)\n- Nate Haug [@quicksketch](https://github.com/quicksketch)\n\nCredits\n-------\n\nThanks to all the Drush maintainers for their project, in particular:\n\n- [Greg Anderson](https://github.com/greg-1-anderson)\n- [Moshe Weitzman](https://github.com/weitzman)\n\nfor their help in making Drush for Backdrop possible.\n\n![Drush Logo](backdrop-drush-extension-logopn.png)\n\nReleasing Versions\n------------------\n\nWe are using [`release-it`](https://github.com/release-it/release-it) to manage releases.  When you are ready for a release:\n\n```bash\nnode_modules/.bin/release-it\n```\n\n* NOTE that you need to set your `GITHUB_TOKEN` in your environment in order to push and cut releases on GitHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackdrop-contrib%2Fbackdrop-drush-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbackdrop-contrib%2Fbackdrop-drush-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackdrop-contrib%2Fbackdrop-drush-extension/lists"}