Files
mokocli/PLUGIN_SCRIPTS.md
Jonathan Miller 95880d3e44
Platform: mokocli CI / Gate 2: Unit Tests (8.1) (pull_request) Blocked by required conditions
Platform: mokocli CI / Gate 2: Unit Tests (8.2) (pull_request) Blocked by required conditions
Platform: mokocli CI / Gate 2: Unit Tests (8.3) (pull_request) Blocked by required conditions
Platform: mokocli CI / Gate 3: Self-Health Check (pull_request) Blocked by required conditions
Platform: mokocli CI / Gate 4: Governance (pull_request) Blocked by required conditions
Platform: mokocli CI / Gate 5: Template Integrity (pull_request) Blocked by required conditions
Platform: mokocli CI / CI Summary (pull_request) Blocked by required conditions
Universal: PR Check / Build RC Package (pull_request) Blocked by required conditions
Universal: PR Check / Report Issues (pull_request) Blocked by required conditions
Universal: PR Check / Branch Policy (pull_request) Successful in 1s
Universal: PR Check / Validate PR (pull_request) Failing after 5s
Universal: PR Check / Secret Scan (pull_request) Successful in 7s
RC Revert / Rename rc/ back to dev/ (pull_request) Has been skipped
Branch Cleanup / Delete merged branch (pull_request) Failing after 1s
Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 14s
Platform: mokocli CI / Gate 1: Code Quality (pull_request) Failing after 53s
chore: complete namespace cleanup — remove all mokoplatform/MokoStandards/MokoEnterprise refs
390 files: templates, workflows, MCP servers, CLI tools, lib, deploy,
validate, wrappers, configs, docs. Pure find-and-replace.
2026-06-21 01:18:13 -05:00

94 lines
2.6 KiB
Markdown

<!--
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
SPDX-License-Identifier: GPL-3.0-or-later
FILE INFORMATION
DEFGROUP: MokoPlatform.Root
INGROUP: MokoPlatform
REPO: https://git.mokoconsulting.tech/MokoConsulting/mokocli
PATH: /PLUGIN_SCRIPTS.md
BRIEF: Plugin system CLI documentation
-->
# Plugin System CLI Scripts
Command-line scripts for validating, health checking, and managing projects using the mokocli plugin system.
## Available Scripts
| Script | Purpose |
|--------|---------|
| `plugin_validate.php` | Validate project structure and configuration |
| `plugin_health_check.php` | Run comprehensive health checks |
| `plugin_metrics.php` | Collect project metrics |
| `plugin_readiness.php` | Check release readiness |
| `plugin_list.php` | List all available plugins |
## Quick Examples
```bash
# List all available plugins
php api/plugin_list.php
# Validate a project (auto-detect type)
php api/plugin_validate.php --project-path /path/to/project
# Run health check
php api/plugin_health_check.php --project-path /path/to/project
# Collect metrics
php api/plugin_metrics.php --project-path /path/to/project --format table
# Check release readiness
php api/plugin_readiness.php --project-path /path/to/project
```
## Supported Project Types
- **joomla** - Joomla CMS projects and extensions
- **wordpress** - WordPress themes and plugins
- **nodejs** - Node.js applications and packages
- **python** - Python applications and packages
- **terraform** - Infrastructure as Code
- **mobile** - Mobile applications (iOS/Android)
- **api** - REST API and GraphQL services
- **dolibarr** - Dolibarr ERP/CRM modules
- **documentation** - Documentation projects
- **generic** - Generic project types
## Exit Codes
- **0** - Success
- **1** - Validation/check failed
- **2** - Script error (invalid arguments, plugin not found)
## Documentation
For detailed documentation, see:
- [Plugin Validation Workflow Templates](../templates/workflows/README.md)
- [Plugin System Implementation](lib/Enterprise/README.md)
- Script help: `php api/plugin_*.php --help`
## Integration
These scripts integrate with:
- GitHub Actions workflows (see `templates/workflows/`)
- Plugin system (see `lib/Enterprise/`)
- CI/CD pipelines (GitLab CI, Jenkins, etc.)
## Usage in CI/CD
```yaml
# GitHub Actions example
- name: Validate project
run: |
php api/plugin_validate.php --project-path . --json > validation.json
if jq -e '.valid == false' validation.json > /dev/null; then
exit 1
fi
```
For complete usage examples and documentation, run any script with `--help`:
```bash
php api/plugin_validate.php --help
```