This DDEV add-on provides seamless integration of essential CiviCRM CLI tools within your DDEV-managed projects. The add-on simplifies the use of tools like civistrings
, civix
, coworker
, and cv
, enhancing the developer experience for CiviCRM projects integrated with CMS platforms such as Drupal and Backdrop.
ddev get vinugawade/ddev-civicrm-cli-tools
ddev restart
ddev composer require civicrm/cli-tools
ddev cv --version
The add-on exposes the following commands:
ddev civistrings
Execute the civistrings
tool inside the web container.
cvstr
ddev civistrings -o myfile.pot myfolder
ddev civistrings --version
ddev civix
Execute the civix
tool inside the web container.
cvx
ddev civix build:zip
ddev civix upgrade
ddev coworker
Execute the coworker
tool inside the web container.
cowkr
ddev coworker list
ddev coworker debug
ddev cv
Execute the cv
tool inside the web container.
cv
ddev cv flush
ddev cv upgrade:db
.
├── LICENSE # License for the project.
├── README.md # Documentation for the add-on.
├── commands # Directory containing CLI command stubs.
│ └── web
│ ├── civistrings # Stub for civistrings command.
│ ├── civix # Stub for civix command.
│ ├── coworker # Stub for coworker command.
│ └── cv # Stub for cv command.
├── install.yaml # Configuration for DDEV add-on installation.
└── tests # Automated tests for the add-on.
├── test.bats # Main test file for the add-on.
└── testdata # Sample data for testing.
└── composer.json # Sample composer configuration.
Contributions are welcome! To get started:
git checkout -b feature/your-feature
git commit -m "Add your message here"
The add-on includes automated tests written in BATS.
cd <ddev-civicrm-cli-tools add-on path>/tests
bats test.bats
👤 Vinay Gawade, Connect with me:
Special thanks to the CiviCRM
and DDEV
communities for their tools and support!