civicrm-buildkit

Buildkit is a collection of ~20 tools for developing and testing CiviCRM.

Documentation

For installation instructions and other documentation, see CiviCRM Developer Guide: Buildkit.

Bundled tools

• CiviCRM
  • civix - Generate skeletal code for CiviCRM extensions.
  • civistrings - Scan code for translatable strings (*.pot).
  • cividist - Generate tarballs from a series of git branches/tags.
  • cv - Administer a Civi DB. Execute custom PHP in Civi.
• Dependency management
  • composer - Manage dependencies for PHP code.
  • bower - Manage dependencies for Javascript code.
• Source code management
  • git-scan - Manage a large number of git repositories.
  • gitify - Convert a CiviCRM installation to a git repo.
  • hub - Send commands to github.com.
• Source code quality
  • civilint - Check the syntax of uncommitted files using phpcs, jshint, etc.
  • jshint - Check the syntax of Javascript files.
  • phpcs - Check the syntax of PHP files.
  • coder 2.x (Civi) - Configure phpcs for Civi code style. Derived from coder 2.x. (The CiviCRM coding standard derives from the Drupal coding standard with variations for class/function/variable naming.)
• Site management
  • amp - Abstracted interface for local httpd/sql service (Apache/nginx/MySQL).
  • civibuild - Build a complete source tree (with CMS+Civi+addons), provision httpd/sql, etc.
  • civihydra - Create a series test sites for several CMSs. (Extends civibuild.)
  • drush and drush8 - Administer a Drupal site.
  • joomla (joomla-console) - Administer a Joomla site.
  • wp (wp-cli) - Administer a WordPress site.
• Testing
  • civicrm-upgrade-test - Scripts and data files for testing upgrades.
  • karma (w/jasmine) - Unit testing for Javascript.
  • paratest - Parallelized version of PHPUnit.
  • phpunit and phpunit4 - Unit testing for PHP (with Selenium and DB add-ons).