Maintainer

Maintainer provides a single entry point for repetitive package and application maintenance tasks, including validation, commits, versioning, changelogs, deployments, and GitHub releases.

This guide covers Maintainer 1.10. If your version class still uses WithReadmeBadgeVersion, follow the README badge migration.

Requirements

• PHP 8.5 or later within the PHP 8.x series
• Composer
• Git
• GitHub CLI for workflows that interact with GitHub

Installation

Install Maintainer as a development dependency:

composer require --dev artisan-toolbox/maintainer:^1.10

The PHAR bundles Maintainer’s CLI dependencies and keeps them separate from the project being maintained.

Open the menu

Open its interactive menu:

vendor/bin/maintainer

The menu groups commands by workflow. Run vendor/bin/maintainer list to see the available command names.

Initialize project configuration:

vendor/bin/maintainer config:publish

Common workflows

Maintainer’s documentation follows the same groups as its interactive menu:

• Code Quality: apply automated fixes and run PHP and frontend checks as configurable workflows.
• Configuration: publish templates and manage settings, secrets, and SSH keys.
• Deployment: run and unlock Deployer or attach shared repository and PM2 tasks.
• Versioning: review diffs, create commits, and publish GitHub releases.

Open a feature page for its requirements, configuration, examples, interactive behavior, automation behavior, and failure conditions.

Learn more

• Command index
• Project integration
• Development and building

Source and releases

• Source code
• Packagist releases