{"id":23657882,"url":"https://github.com/vinugawade/ddev-civicrm-cli-tools","last_synced_at":"2025-08-05T06:29:52.646Z","repository":{"id":269841832,"uuid":"908624626","full_name":"vinugawade/ddev-civicrm-cli-tools","owner":"vinugawade","description":"Tools to streamline CiviCRM workflows with seamless integration and efficient task management.","archived":false,"fork":false,"pushed_at":"2024-12-27T15:00:24.000Z","size":77,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-27T15:24:01.333Z","etag":null,"topics":["add-on","civicrm","ddev","ddev-get","drupal","php"],"latest_commit_sha":null,"homepage":"https://github.com/vinugawade/ddev-civicrm-cli-tools","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vinugawade.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null}},"created_at":"2024-12-26T14:34:23.000Z","updated_at":"2024-12-27T15:09:29.000Z","dependencies_parsed_at":"2024-12-26T15:31:52.742Z","dependency_job_id":"14f47727-70a4-4805-9f6c-9108ecd7a718","html_url":"https://github.com/vinugawade/ddev-civicrm-cli-tools","commit_stats":null,"previous_names":["vinugawade/civicrm-cli-tools","vinugawade/ddev-civicrm-cli-tools"],"tags_count":1,"template":false,"template_full_name":"ddev/ddev-addon-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinugawade%2Fddev-civicrm-cli-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinugawade%2Fddev-civicrm-cli-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinugawade%2Fddev-civicrm-cli-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinugawade%2Fddev-civicrm-cli-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vinugawade","download_url":"https://codeload.github.com/vinugawade/ddev-civicrm-cli-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231684210,"owners_count":18410622,"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":["add-on","civicrm","ddev","ddev-get","drupal","php"],"created_at":"2024-12-28T22:32:53.057Z","updated_at":"2025-08-05T06:29:52.634Z","avatar_url":"https://github.com/vinugawade.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 DDEV CiviCRM CLI Tools Add-on\n[![Tests for `ddev-civicrm-cli-tools`](https://github.com/vinugawade/ddev-civicrm-cli-tools/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/vinugawade/ddev-civicrm-cli-tools/actions/workflows/tests.yml)\n\nThis 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.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Repository Structure](#repository-structure)\n- [Contributing](#contributing)\n- [Maintainer](#maintainer)\n- [Acknowledgments](#acknowledgments)\n\n## Features\n\n- **Simplified Command Execution**: Easily run CiviCRM CLI tools directly through DDEV commands.\n- **Wide Compatibility**: Works seamlessly with Drupal (9, 10, 11), Backdrop, and CiviCRM installations.\n- **Error Handling**: Provides clear and actionable error messages for missing dependencies or setup issues.\n- **Tested Environment**: Includes automated BATS tests to validate functionality, ensuring stability and reliability.\n- **Support for Multi-Context Projects**: Works across local development and production environments with minimal configuration.\n\n## Installation\n\n### Prerequisites\n\n- DDEV version 1.19+.\n- PHP 7.4 or higher.\n- Composer installed in your environment.\n- CiviCRM integrated with a supported CMS (Drupal or Backdrop).\n\n### Steps\n\n1. **Download the Add-on**:\n   ```bash\n   ddev get vinugawade/ddev-civicrm-cli-tools\n   ```\n\n2. **Restart Your DDEV Project**:\n   ```bash\n   ddev restart\n   ```\n\n3. **Install Required Dependencies**:\n   ```bash\n   ddev composer require civicrm/cli-tools\n   ```\n\n4. **Verify Installation**:\n   Run any CLI command to ensure proper setup:\n   ```bash\n   ddev cv --version\n   ```\n\n## Usage\n\nThe add-on exposes the following commands:\n\n### 1. `ddev civistrings`\n\nExecute the `civistrings` tool inside the web container.\n\n- **Alias**: `cvstr`\n- **Examples**:\n  ```bash\n  ddev civistrings -o myfile.pot myfolder\n  ddev civistrings --version\n  ```\n\n### 2. `ddev civix`\n\nExecute the `civix` tool inside the web container.\n\n- **Alias**: `cvx`\n- **Examples**:\n  ```bash\n  ddev civix build:zip\n  ddev civix upgrade\n  ```\n\n### 3. `ddev coworker`\n\nExecute the `coworker` tool inside the web container.\n\n- **Alias**: `cowkr`\n- **Examples**:\n  ```bash\n  ddev coworker list\n  ddev coworker debug\n  ```\n\n### 4. `ddev cv`\n\nExecute the `cv` tool inside the web container.\n\n- **Alias**: `cv`\n- **Examples**:\n  ```bash\n  ddev cv flush\n  ddev cv upgrade:db\n  ```\n\n## Repository Structure\n\n```shell\n.\n├── LICENSE             # License for the project.\n├── README.md           # Documentation for the add-on.\n├── commands            # Directory containing CLI command stubs.\n│   └── web\n│       ├── civistrings # Stub for civistrings command.\n│       ├── civix       # Stub for civix command.\n│       ├── coworker    # Stub for coworker command.\n│       └── cv          # Stub for cv command.\n├── install.yaml        # Configuration for DDEV add-on installation.\n└── tests               # Automated tests for the add-on.\n    ├── test.bats       # Main test file for the add-on.\n    └── testdata        # Sample data for testing.\n        └── composer.json # Sample composer configuration.\n```\n\n---\n\n## Contributing\n\nContributions are welcome! To get started:\n\n1. Fork the repository.\n2. Create a feature branch:\n   ```bash\n   git checkout -b feature/your-feature\n   ```\n3. Commit your changes:\n   ```bash\n   git commit -m \"Add your message here\"\n   ```\n4. Push to your fork and submit a pull request.\n\n### Testing\n\nThe add-on includes automated tests written in [BATS](https://github.com/bats-core/bats-core).\n\n#### Running Tests\n\n1. Navigate to the add-on directory:\n   ```bash\n   cd \u003cddev-civicrm-cli-tools add-on path\u003e/tests\n   ```\n2. Run the tests:\n   ```bash\n   bats test.bats\n   ```\n\n## Maintainer\n\n👤 **Vinay Gawade**, Connect with me:\n\n- [GitHub](https://github.com/vinugawade)\n- [Drupal](https://www.drupal.org/u/vinaygawade)\n- [LinkedIn](https://www.linkedin.com/in/vinu-gawade)\n\n## Acknowledgments\n\nSpecial thanks to the `CiviCRM` and `DDEV` communities for their tools and support!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinugawade%2Fddev-civicrm-cli-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvinugawade%2Fddev-civicrm-cli-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinugawade%2Fddev-civicrm-cli-tools/lists"}