Bee is a command line utility for Backdrop CMS. It includes commands that allow developers to interact with Backdrop sites, performing actions like:
- Running cron
- Clearing caches
- Downloading and installing Backdrop
- Downloading, enabling and disabling projects
- Viewing information about a site and/or available projects
Please note that Bee is under active development and, as such, breaking changes may occur. Please see the release notes for a list of any major changes between versions. Also note that Bee is not (yet?) compatible with Microsoft Windows.
-
Download (or clone) Bee to your computer/server.
This will create a folder calledbeewith lots of files inside. Your home directory is a good location for this folder. -
Make sure
bee/bee.phpis executable.
It should be by default, but it doesn't hurt to double-check. -
Make it easy to run
beecommands.
There are two ways to do this:-
Put a symlink to
bee/bee.phpin your$PATH(e.g.sudo ln -s /path/to/bee/bee.php /usr/local/bin/bee) -
Make a Bash alias for
bee(e.g. addalias bee='/path/to/bee/bee.php'to your.bash_aliasesfile)
-
-
Test to make sure it works.
Simply typebeein your terminal and you should see a list of available commands displayed.
More advanced/specialised installation instructions can be found in the wiki.
Bee can be extended (i.e. custom/additional commands added) by Backdrop contrib modules or by individual users. See API.md for details.
Bugs and feature requests should be reported in the issue queue: https://github.com/backdrop-contrib/bee/issues.
- Martin Price - System Horizons
- Collaboration and co-maintainers welcome!
- Originally written for Backdrop CMS by
Geoff St. Pierre
(originally called 'Backdrop Console (a.k.a.b)'). - Grateful thanks goes to previous maintainers and collaborators who have helped bring Bee to where it is today. See the list of contributors for details.
- Inspired by Drush.
- Bee icon by AomAm from the Noun Project.
This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.