Cms Cli Laravel Package

Getting Started

Start by installing typo3/cms-cli via Composer: composer require --dev typo3/cms-cli. Though minimal documentation exists, the package exposes a small set of self-documenting commands—run ./vendor/bin/typo3 list to inspect available operations (e.g., cache:flush, extension:activate, system:check). The first use case is typically cache clearing in CI: ./vendor/bin/typo3 cache:flush --type=system. No configuration is required out of the box; it auto-detects the TYPO3 instance when run from the project root (where typo3_src or vendor/typo3/cms-* is present).

Implementation Patterns

• CI/CD Integration: Add TYPO3 tasks to your pipeline as explicit, idempotent steps (e.g., typo3 extension:activate MyExt after deployment, followed by typo3 database:update).
• Environment Abstraction: Use typo3 system:check before deploys to validate environment readiness; combine with shell conditionals (if typo3 system:check; then deploy.sh; fi).
• Scripting Workflow: Wrap common sequences in reusable shell scripts (e.g., maintain.sh runs typo3 cache:flush && typo3 extension:list --enabled-only), reducing manual drift across environments.
• Output Parsing: Leverage structured output (e.g., --format=json) where supported to consume results programmatically—critical for monitoring hooks or custom tooling.

Gotchas and Tips

• Working Directory Matters: Commands assume the current directory is the TYPO3 root (contains index.php, typo3/). Run from the project root, not public/ or vendor/.
• Silent Failures: Some commands exit cleanly even if partial failures occur; always pair with set -euo pipefail in bash or explicit exit-code checks.
• No Version Locking: This package tracks TYPO3 core APIs—ensure your typo3/cms-cli version aligns with your TYPO3 major version (e.g., v12 for TYPO3 12.x).
• Extensibility: While not officially extensible, commands often delegate to core TYPO3 commands—inspect vendor/typo3/cms-cli/src/Command/ to reverse-engineer behavior or copy-patch logic for missing features.
• Debugging: Run with --verbose to see underlying TYPO3 CLI command invocations; combine with strace or bash -x to trace environment-specific failures (e.g., file permissions, missing CLI extensions).