craftcms/craft6-revamp

Craft 6 project prepper

Maintainers

Package info

github.com/craftcms/craft6-revamp

pkg:composer/craftcms/craft6-revamp

Statistics

Installs: 72

Dependents: 0

Suggesters: 0

Stars: 3

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

0.0.2 2025-09-23 07:46 UTC

Requires

Requires (Dev)

MIT 78a0f06040b8295a13591f48d7a42688c7ba3a20

  • Brandon Kelly <brandon.woop@pixelandtonic.com>

craftcms

This package is auto-updated.

Last update: 2026-02-27 22:31:44 UTC

README

This CLI tool automates a number of steps in the Craft 6 upgrade process.

Tip

Keep an eye on our Planning for the Laravel Transition article for complete upgrade instructions, as the first Alpha release approaches!

Summary of actions 🪄

The following tasks are handled by the script. A description of each action is output to the console, followed by a confirmation or error message.

You will be prompted before the tool takes potentially destructive actions.

  • Verifies you’re running a supported version of Craft 5;
  • Updates Composer dependencies for Craft and the Generator, adds craftcms/yii2-adapter, and removes vlucas/phpdotenv;
  • Switches the DDEV project type to laravel, and updates the project’s PHP version;
  • Renames a handful of environment variables to match Laravel conventions;
  • Creates the artisan CLI entrypoint, Laravel’s bootstrap/ files, and replaces index.php;
  • Scaffolds Laravel’s framework/ directory;
  • Moves existing Craft-specific configuration files into config/craft/;
  • Renames the web root to public/;
  • Renames the translations/ directory to lang/;
  • Removes boostrap.php;

A few manual follow-up actions are then suggested, when relevant to your project.

Caution

Make sure you have a way to restore your project, if you encounter issues. Use this tool at your own risk, and do not run this on your live server! It is only intended to upgrade projects in a development environment.

Installation

The tool is installed as a global Composer package, on any system running PHP 8.2 or newer.

composer global require craftcms/craft6-revamp -W

DDEV or Docker users: it is safe to do this from any directory on your host machine. It should not alter your project’s composer.json.

If you get a dependency conflict error, try running the following command first:

composer global update

Usage

To prepare an existing Craft 5 project for Craft 6, run the tool from its root directory:

craft6-revamp

The tool will exit if it can’t find composer.json and composer.lock files, or if it can’t confidently determine the project is compatible.

If the command doesn’t resolve (say, because your user’s Composer bin directory is not in your $PATH), you can run the command directly:

~/.composer/vendor/bin/craft6-revamp

You may also pass a --path, if you have many projects to update:

craft6-revamp --path /path/to/project