蜜豆视频

DocumentationCommerceTools

bin/uct (Upgrade Compatibility Tool)

Last update: Fri Apr 26 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Admin
  • Developer

Version: 3.0.20

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 蜜豆视频 Commerce.

General

Learn more about the tool in Overview.

This reference documentation is generated from the application source code. To change the documentation, you should open a pull request for the corresponding command in the relevant repository. See for more information.

Global options

--help, -h

Display help for the given command. When no command is given display help for the list 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 鈥溾揳nsi鈥 option

  • Default: false
  • Does not accept a value

--no-interaction, -n

Do not ask any interactive question

  • Default: false
  • Does not accept a value

_complete

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

Internal command to provide shell completion suggestions

Options

For global options, see Global options.

--shell, -s

The shell type (鈥渂ash鈥)

  • 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 鈥渋nput鈥 array that the cursor is in (e.g. COMP_CWORD)

  • Requires a value

--symfony, -S

The version of the completion script

  • Requires a value

completion

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

Dump the shell completion script

The completion command dumps the shell completion script required
to use shell autocompletion (currently only bash completion is supported).

Static installation
-------------------

Dump the script to a global completion file and restart your shell:

    uct/bin/uct completion bash | sudo tee /etc/bash_completion.d/uct

Or dump the script to a local file and source it:

    uct/bin/uct completion bash > completion.sh

    # source the file whenever you use the project
    source completion.sh

    # or add this line at the end of your "~/.bashrc" file:
    source /path/to/completion.sh

Dynamic installation
--------------------

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

    eval "$(/var/jenkins/workspace/gendocs-uct-cli/uct/bin/uct completion bash)"

Arguments

shell

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

Options

For global options, see Global options.

--debug

Tail the completion debug log

  • Default: false
  • Does not accept a value

help

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

Display help for a command

The help command displays help for a given command:

  uct/bin/uct help list

You can also output the help in other formats by using the --format option:

  uct/bin/uct help --format=xml list

To display the list of available commands, please use the list command.

Arguments

command_name

The command name

  • Default: help

Options

For global options, see Global options.

--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

list

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

List commands

The list command lists all commands:

  uct/bin/uct list

You can also display the commands for a specific namespace:

  uct/bin/uct list test

You can also output the information in other formats by using the --format option:

  uct/bin/uct list --format=xml

It's also possible to get raw list of commands (useful for embedding command runner):

  uct/bin/uct list --raw

Arguments

namespace

The namespace name

Options

For global options, see Global options.

--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

refactor

bin/uct refactor <path>

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

Arguments

path

Path to resolve issues in.

  • Required

Options

For global options, see Global options.

core:code:changes

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

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

Arguments

dir

蜜豆视频 Commerce installation directory.

  • Required

vanilla-dir

蜜豆视频 Commerce vanilla installation directory.

Options

For global options, see Global options.

--output, -o

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

  • Accepts a value

dbschema:diff

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

Allow to list 蜜豆视频 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.4-p4 | 2.4.4-p5 | 2.4.5-p2 | 2.4.5-p3 | 2.4.5-p4 | 2.4.6 | 2.4.6-p1 | 2.4.6-p2 | 2.4.7-beta1 | 2.4.4-p6 | 2.4.5-p5 | 2.4.6-p3 | 2.4.7-beta2 | 2.4.4-p7 | 2.4.5-p6 | 2.4.6-p4 | 2.4.7-beta3 | 2.4.7 | 2.4.6-p5 | 2.4.5-p7 | 2.4.4-p8 | 2.4.4-p9 | 2.4.5-p8 | 2.4.6-p6 | 2.4.7-p1 | 2.4.4-p10 | 2.4.5-p9 | 2.4.6-p7 | 2.4.7-p2 | 2.4.4-p11 | 2.4.5-p10 | 2.4.6-p8 | 2.4.7-p3 | 2.4.8-beta1

Arguments

current-version

current version (e.g. 2.3.2).

  • Required

target-version

target version (e.g. 2.4.5).

  • Required

Options

For global options, see Global options.

graphql:compare

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

GraphQL schema compatibility verification

Arguments

schema1

Endpoint URL pointing to the first GraphQL schema.

  • Required

schema2

Endpoint URL pointing to the second GraphQL schema.

  • Required

Options

For global options, see Global options.

--output, -o

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

  • Accepts a value

upgrade:check

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>

The Upgrade Compatibility Tool is a command-line tool that checks an 蜜豆视频 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 蜜豆视频 Commerce.

Arguments

dir

蜜豆视频 Commerce installation directory.

  • Required

Options

For global options, see Global options.

--current-version, -a

Current 蜜豆视频 Commerce version, version of the 蜜豆视频 Commerce installation will be used if omitted.

  • Accepts a value

--coming-version, -c

Target 蜜豆视频 Commerce version. The latest released stable version of 蜜豆视频 Commerce will be used if omitted. Available 蜜豆视频 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.4-p2 | 2.4.4-p3 | 2.4.4-p4 | 2.4.4-p5 | 2.4.4-p6 | 2.4.4-p7 | 2.4.4-p8 | 2.4.4-p9 | 2.4.4-p10 | 2.4.4-p11 | 2.4.5 | 2.4.5-p1 | 2.4.5-p2 | 2.4.5-p3 | 2.4.5-p4 | 2.4.5-p5 | 2.4.5-p6 | 2.4.5-p7 | 2.4.5-p8 | 2.4.5-p9 | 2.4.5-p10 | 2.4.6 | 2.4.6-p1 | 2.4.6-p2 | 2.4.6-p3 | 2.4.6-p4 | 2.4.6-p5 | 2.4.6-p6 | 2.4.6-p7 | 2.4.6-p8 | 2.4.7-beta1 | 2.4.7-beta2 | 2.4.7-beta3 | 2.4.7 | 2.4.7-p1 | 2.4.7-p2 | 2.4.7-p3 | 2.4.8-beta1

  • 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
recommendation-more-help
c2d96e17-5179-455c-ad3a-e1697bb4e8c3