https://github.com/backdrop-contrib/bee
:bee: Bee is a command line utility for Backdrop CMS. It includes commands that allow developers to interact with Backdrop sites.
https://github.com/backdrop-contrib/bee
backdrop backdropcms cli cms command-line-tool php
Last synced: 3 months ago
JSON representation
:bee: Bee is a command line utility for Backdrop CMS. It includes commands that allow developers to interact with Backdrop sites.
- Host: GitHub
- URL: https://github.com/backdrop-contrib/bee
- Owner: backdrop-contrib
- License: gpl-2.0
- Created: 2015-10-04T15:18:49.000Z (over 10 years ago)
- Default Branch: 1.x-1.x
- Last Pushed: 2024-11-18T15:28:56.000Z (about 1 year ago)
- Last Synced: 2024-11-18T17:03:12.389Z (about 1 year ago)
- Topics: backdrop, backdropcms, cli, cms, command-line-tool, php
- Language: PHP
- Homepage:
- Size: 544 KB
- Stars: 16
- Watchers: 25
- Forks: 22
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Bee
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
See the Release notes and the Changelog for details of changes between
versions.
## Requirements
### Operating System
- Bee will work in most Linux based environments.
- Bee will NOT work natively in Windows but can be used inside Linux based
virtual environments such as WSL2.
- Bee requires the `mysql` and `mysqldump` executables to be installed for most
database operations (i.e. `db-export`, `db-import`, `db-drop`, `sql` but NOT
`db-query`).
### PHP
- Bee is tested and works from `7.4` up to `8.3`.
## Installation
- Download (or clone) Bee to your computer/server.
This will create a folder called `bee` with lots of files inside. Your home
directory is a good location for this folder. It is neither required nor
recommended to place this folder within the Backdrop web root.
- Make sure `bee/bee.php` is executable.
It should be by default, but it doesn't hurt to double-check.
- Make it easy to run `bee` commands.
There are two ways to do this:
1. Put a symlink to `bee/bee.php` in your `$PATH` (e.g.
`sudo ln -s /path/to/bee/bee.php /usr/local/bin/bee`)
2. Make a Bash alias for `bee` (e.g. add `alias bee='/path/to/bee/bee.php'` to
your `.bash_aliases` file)
- Test to make sure it works.
Simply type `bee` in your terminal and you should see a list of available
commands displayed.
More advanced/specialised installation instructions can be found in the
[wiki](https://github.com/backdrop-contrib/bee/wiki).
## Extending
Bee can be extended (i.e. custom/additional commands added) by Backdrop contrib
modules or by individual users. See
[API.md](https://github.com/backdrop-contrib/bee/blob/1.x-1.x/API.md) for
details.
## Issues
Bugs and feature requests should be reported in the issue queue:
https://github.com/backdrop-contrib/bee/issues.
## Current Maintainers
- [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons](https://www.systemhorizons.co.uk)
- Collaboration and co-maintainers welcome!
## Credits
- Originally written for Backdrop CMS by
[Geoff St. Pierre](https://github.com/serundeputy)
(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](https://github.com/backdrop-contrib/bee/graphs/contributors)
for details. Contributions by "BWpanda" were made by Peter Anderson and not the
user who is currently associated with the "BWpanda" user name.
- Inspired by [Drush](https://github.com/drush-ops/drush).
- [Bee icon](https://thenounproject.com/aomam/collection/bee-emoticons-line/?i=2257433)
by AomAm from [the Noun Project](http://thenounproject.com).
## License
This project is GPL v2 software.
See the LICENSE.txt file in this directory for complete text.