<!--
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
SPDX-License-Identifier: GPL-3.0-or-later
FILE INFORMATION
DEFGROUP: MokoStandards.Root
INGROUP: MokoStandards
REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
PATH: /README.md
VERSION: 09.02.05
BRIEF: Project overview and documentation
-->

# MokoStandards Enterprise API

![Version](https://img.shields.io/badge/version-09.01.00-blue) ![PHP](https://img.shields.io/badge/PHP-8.1%2B-777BB4) ![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green)

PHP implementation of MokoStandards — enterprise standards, automation framework, workflow templates, and bulk sync tooling.

> **Primary platform**: [Gitea — git.mokoconsulting.tech](https://git.mokoconsulting.tech/MokoConsulting/MokoStandards-API)
> **Backup mirror**: [GitHub](https://github.com/MokoConsulting/MokoStandards-API) *(read-only mirror)*

## What Lives Here

| Directory | Purpose |
|-----------|---------|
| `lib/Enterprise/` | 38 PHP enterprise library classes (platform adapters, sync, validation, plugins) |
| `cli/` | CLI scripts (archive, create, release, sync rulesets, version management) |
| `automation/` | Bulk sync, push files, repo cleanup, Gitea migration |
| `validate/` | 18 validation scripts (health, structure, secrets, syntax, drift) |
| `templates/` | **Workflow templates** and config templates synced to governed repos |
| `definitions/` | Repository structure definitions (`.tf` format) |
| `deploy/` | Deployment scripts (SFTP, Joomla) |
| `maintenance/` | Labels, inventory, SHA pinning, version sync |
| `tools/` | Standalone tools (legal doc generator) |
| `tests/` | PHPUnit test suite |

## Installation

```bash
composer require mokoconsulting-tech/enterprise
```

### Composer Registry

This package is served from Gitea package registry. Add this to your `composer.json`:

```json
{
    "repositories": [
        {
            "type": "composer",
            "url": "https://git.mokoconsulting.tech/api/packages/MokoConsulting/composer"
        }
    ]
}
```

## CLI Tools

```bash
# Health check
vendor/bin/moko health -- --path .

# Sync standards
vendor/bin/moko sync

# Inventory
vendor/bin/moko inventory -- --path .
```

## Platform Configuration

| Variable | Purpose |
|----------|---------|
| `GIT_PLATFORM` | `gitea` (default) or `github` |
| `GA_TOKEN` | Gitea API / Gitea Actions token |
| `GH_TOKEN` | GitHub API token (for mirror sync) |
| `GITEA_URL` | Gitea instance URL (default: `https://git.mokoconsulting.tech`) |
| `GITEA_ORG` | Gitea organization (default: `MokoConsulting`) |

## License

GPL-3.0-or-later — See [LICENSE.md](LICENSE.md)