bin/uct (Upgrade Compatibility Tool)

Version: 3.0.3

This reference contains 9 commands available through the bin/uct command-line tool.
The initial list is auto generated using the bin/uct list command at Adobe Commerce.

Learn more about the tool in Overview.

_complete

Internal command to provide shell completion suggestions

bin/uct _complete [-s|--shell SHELL] [-i|--input INPUT] [-c|--current CURRENT] [-S|--symfony SYMFONY]

--shell, -s

The shell type ("bash")

• Requires a value

--input, -i

An array of input tokens (e.g. COMP_WORDS or argv)

• Default: []
• Requires a value

--current, -c

The index of the "input" array that the cursor is in (e.g. COMP_CWORD)

• Requires a value

--symfony, -S

The version of the completion script

• Requires a value

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

completion

Dump the shell completion script

bin/uct completion [--debug] [--] [<shell>]

shell

The shell type (e.g. "bash"), the value of the "$SHELL" env var will be used if this is not given

--debug

Tail the completion debug log

• Default: false
• Does not accept a value

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

help

Display help for a command

bin/uct help [--format FORMAT] [--raw] [--] [<command_name>]

command_name

The command name

• Default: help

--format

The output format (txt, xml, json, or md)

• Default: txt
• Requires a value

--raw

To output raw command help

• Default: false
• Does not accept a value

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

list

List commands

bin/uct list [--raw] [--format FORMAT] [--short] [--] [<namespace>]

namespace

The namespace name

--raw

To output raw command list

• Default: false
• Does not accept a value

--format

The output format (txt, xml, json, or md)

• Default: txt
• Requires a value

--short

To skip describing commands’ arguments

• Default: false
• Does not accept a value

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

refactor

Resolves the issues that can be fixed automatically. The code in the path provided will be updated.

bin/uct refactor <path>

path

Path to resolve issues in.

• Required

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

core:code:changes

The Upgrade Compatibility Tool is a command-line tool that checks a Adobe Commerce instance against a specific version by analyzing all the non-Adobe Commerce modules installed in it. Returns a list of errors and warnings that you must address before upgrading to a new version of Adobe Commerce code.

bin/uct core:code:changes [-o|--output [OUTPUT]] [--] <dir> [<vanilla-dir>]

dir

Adobe Commerce installation directory.

• Required

vanilla-dir

Adobe Commerce vanilla installation directory.

--output, -o

Path of the file where the output will be exported (Json Format)

• Accepts a value

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

dbschema:diff

Allow to list Adobe Commerce DB schema differences between two selected versions.
Available versions: 2.3.0 | 2.3.1 | 2.3.2 | 2.3.2-p2 | 2.3.3 | 2.3.3-p1 | 2.3.4 | 2.3.4-p1 | 2.3.4-p2 | 2.3.5 | 2.3.5-p1 | 2.3.5-p2 | 2.3.6 | 2.3.6-p1 | 2.3.7 | 2.3.7-p1 | 2.3.7-p2 | 2.3.7-p3 | 2.3.7-p4 | 2.4.0 | 2.4.0-p1 | 2.4.1 | 2.4.1-p1 | 2.4.2 | 2.4.2-p1 | 2.4.2-p2 | 2.4.3 | 2.4.3-p1 | 2.4.3-p2 | 2.4.3-p3 | 2.4.4 | 2.4.4-p1 | 2.4.5 | 2.4.4-p2 | 2.4.5-p1 | 2.4.4-p3 | 2.4.5-p2 | 2.4.6

bin/uct dbschema:diff <current-version> <target-version>

current-version

current version (e.g. 2.3.2).

• Required

target-version

target version (e.g. 2.4.5).

• Required

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

graphql:compare

GraphQL schema compatibility verification

bin/uct graphql:compare [-o|--output [OUTPUT]] [--] <schema1> <schema2>

schema1

Endpoint URL pointing to the first GraphQL schema.

• Required

schema2

Endpoint URL pointing to the second GraphQL schema.

• Required

--output, -o

Path of the file where the output will be exported (JSON Format)

• Accepts a value

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value

upgrade:check

The Upgrade Compatibility Tool is a command-line tool that checks an Adobe Commerce customized instance against a specific version by analyzing all modules installed in it. Returns a list of errors and warnings that must be addressed before upgrading to the latest version of Adobe Commerce.

bin/uct upgrade:check [-a|--current-version [CURRENT-VERSION]] [-c|--coming-version [COMING-VERSION]] [--json-output-path [JSON-OUTPUT-PATH]] [--html-output-path [HTML-OUTPUT-PATH]] [--min-issue-level [MIN-ISSUE-LEVEL]] [-i|--ignore-current-version-compatibility-issues] [--context CONTEXT] [--] <dir>

dir

Adobe Commerce installation directory.

• Required

--current-version, -a

Current Adobe Commerce version, version of the Adobe Commerce installation will be used if omitted.

• Accepts a value

--coming-version, -c

Target Adobe Commerce version, latest released version of Adobe Commerce will be used if omitted. Available Adobe Commerce versions: 2.3.0 | 2.3.1 | 2.3.2 | 2.3.2-p2 | 2.3.3 | 2.3.3-p1 | 2.3.4 | 2.3.4-p1 | 2.3.4-p2 | 2.3.5 | 2.3.5-p1 | 2.3.5-p2 | 2.3.6 | 2.3.6-p1 | 2.3.7 | 2.3.7-p1 | 2.3.7-p2 | 2.3.7-p3 | 2.3.7-p4 | 2.4.0 | 2.4.0-p1 | 2.4.1 | 2.4.1-p1 | 2.4.2 | 2.4.2-p1 | 2.4.2-p2 | 2.4.3 | 2.4.3-p1 | 2.4.3-p2 | 2.4.3-p3 | 2.4.4 | 2.4.4-p1 | 2.4.5 | 2.4.4-p2 | 2.4.5-p1 | 2.4.4-p3 | 2.4.5-p2 | 2.4.6

• Accepts a value

--json-output-path

Path of the file where the output will be exported in json format

• Accepts a value

--html-output-path

Path of the file where the output will be exported in HTML format

• Accepts a value

--min-issue-level

Minimal issue level you want to see in the report (warning, error or critical).

• Default: warning
• Accepts a value

--ignore-current-version-compatibility-issues, -i

Ignore common issues for current and coming version

• Default: false
• Does not accept a value

--context

Execution context. This option is for integration purposes and does not affect the execution result.

• Requires a value

--help, -h

Display help for the given command. When no command is given display help for the <info>list</info> command

• Default: false
• Does not accept a value

--quiet, -q

Do not output any message

• Default: false
• Does not accept a value

--verbose, -v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Default: false
• Does not accept a value

--version, -V

Display this application version

• Default: false
• Does not accept a value

--ansi

Force (or disable --no-ansi) ANSI output

• Does not accept a value

--no-ansi

Negate the "–ansi" option

• Default: false
• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false
• Does not accept a value