CLI-referens för ECE-verktyg
Version: 2002.2.7
Referensen innehåller 34 kommandon som är tillgängliga via kommandoradsverktyget ece-tools
.
Den inledande listan genereras automatiskt med kommandot ece-tools list
på Adobe Commerce i molninfrastrukturen.
Allmänt
Den här referensen genereras från programmets kodbas. Ge oss feedback (hitta länken i det övre högra hörnet) om du vill ändra innehållet. Information om riktlinjer för bidrag finns i Kodavgifter.
Globala alternativ
--help
, -h
Visa hjälp för det angivna kommandot. När inget kommando anges visas hjälpen för listkommandot
- Standard:
false
- Accepterar inte ett värde
--silent
Skriv inget meddelande
- Standard:
false
- Accepterar inte ett värde
--quiet
, -q
Endast fel visas. Alla andra utdata inaktiveras
- Standard:
false
- Accepterar inte ett värde
--verbose
, -v|-vv|-vvv
Öka meddelandenas utförlighet: 1 för normal utskrift, 2 för mer utförlig utskrift och 3 för felsökning
- Standard:
false
- Accepterar inte ett värde
--version
, -V
Visa den här programversionen
- Standard:
false
- Accepterar inte ett värde
--ansi
Tvinga (eller inaktivera) ANSI-utdata
- Accepterar inte ett värde
--no-ansi
Ignorera alternativet "—ansi"
- Accepterar inte ett värde
--no-interaction
, -n
Ställ inga interaktiva frågor
- Standard:
false
- Accepterar inte ett värde
_complete
ece-tools _complete [-s|--shell SHELL] [-i|--input INPUT] [-c|--current CURRENT] [-a|--api-version API-VERSION] [-S|--symfony SYMFONY]
Internt kommando för att ge förslag på komplettering av skalet
Alternativ
Information om globala alternativ finns i Globala alternativ.
--shell
, -s
Skaltypen ("bash", "fish", "zsh")
- Kräver ett värde
--input
, -i
En array med indatatoken (t.ex. COMP_WORDS eller argv)
- Standard:
[]
- Kräver ett värde
--current
, -c
Indexvärdet för den inmatningsarray där markören finns (t.ex. COMP_CWORD)
- Kräver ett värde
--api-version
, -a
API-versionen av det slutförda skriptet
- Kräver ett värde
--symfony
, -S
inaktuell
- Kräver ett värde
build
ece-tools build
Skapar program.
Alternativ
Information om globala alternativ finns i Globala alternativ.
completion
ece-tools completion [--debug] [--] [<shell>]
Dumpa skriptet för gränssnittets slutförande
The completion command dumps the shell completion script required
to use shell autocompletion (currently, bash, fish, zsh completion are supported).
Static installation
-------------------
Dump the script to a global completion file and restart your shell:
bin/ece-tools completion | sudo tee /etc/bash_completion.d/ece-tools
Or dump the script to a local file and source it:
bin/ece-tools completion > 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-ece-tools-cli/bin/ece-tools completion )"
Argument
shell
Gränssnittstypen (t.ex. "bash"), värdet för "$SHELL" env var, används om detta inte anges
Alternativ
Information om globala alternativ finns i Globala alternativ.
--debug
Avsluta felsökningsloggen
- Standard:
false
- Accepterar inte ett värde
db-dump
ece-tools db-dump [-d|--remove-definers] [-a|--dump-directory DUMP-DIRECTORY] [--] [<databases>...]
Skapar säkerhetskopiering av databaser.
Argument
databases
Databaser för säkerhetskopiering. Tillgängliga värden: [försäljning av huvudofferter]. Om argumentvärdet inte anges skapas databassäkerhetskopior med hjälp av autentiseringsuppgifterna som lagras i miljövariabeln MAGENTO_CLOUD_RELATIONSHIP
eller stage.deploy.DATABASE_CONFIGURATION
i konfigurationsfilen .magento.env.yaml.
- Standard:
[]
- Array
Alternativ
Information om globala alternativ finns i Globala alternativ.
--remove-definers
, -d
Ta bort definitioner från databasdumpen
- Standard:
false
- Accepterar inte ett värde
--dump-directory
, -a
Använd alternativ katalog för att spara dumpen
- Kräver ett värde
deploy
ece-tools deploy
Distribuerar programmet.
Alternativ
Information om globala alternativ finns i Globala alternativ.
help
ece-tools help [--format FORMAT] [--raw] [--] [<command_name>]
Visa hjälp för ett kommando
The help command displays help for a given command:
bin/ece-tools help list
You can also output the help in other formats by using the --format option:
bin/ece-tools help --format=xml list
To display the list of available commands, please use the list command.
Argument
command_name
Kommandonamnet
- Standard:
help
Alternativ
Information om globala alternativ finns i Globala alternativ.
--format
Utdataformatet (txt, xml, json eller md)
- Standard:
txt
- Kräver ett värde
--raw
Hjälp för att skriva ut råformat
- Standard:
false
- Accepterar inte ett värde
list
ece-tools list [--raw] [--format FORMAT] [--short] [--] [<namespace>]
Listkommandon
The list command lists all commands:
bin/ece-tools list
You can also display the commands for a specific namespace:
bin/ece-tools list test
You can also output the information in other formats by using the --format option:
bin/ece-tools list --format=xml
It's also possible to get raw list of commands (useful for embedding command runner):
bin/ece-tools list --raw
Argument
namespace
Namnutrymmets namn
Alternativ
Information om globala alternativ finns i Globala alternativ.
--raw
Utdata för kommandolista
- Standard:
false
- Accepterar inte ett värde
--format
Utdataformatet (txt, xml, json eller md)
- Standard:
txt
- Kräver ett värde
--short
Så här beskriver du inte kommandots argument
- Standard:
false
- Accepterar inte ett värde
patch
ece-tools patch
Använder anpassade patchar.
Alternativ
Information om globala alternativ finns i Globala alternativ.
post-deploy
ece-tools post-deploy
Utför efter distributionsåtgärder.
Alternativ
Information om globala alternativ finns i Globala alternativ.
run
ece-tools run <scenario>...
Kör scenarier.
Argument
scenario
Scenario(er)
-
Standard:
[]
-
Obligatoriskt
-
Array
Alternativ
Information om globala alternativ finns i Globala alternativ.
backup:list
ece-tools backup:list
Visar en lista med säkerhetskopierade filer.
Alternativ
Information om globala alternativ finns i Globala alternativ.
backup:restore
ece-tools backup:restore [-f|--force] [--file [FILE]]
Återställ viktiga konfigurationsfiler. Kör säkerhetskopian :list för att visa listan med säkerhetskopieringsfiler.
Alternativ
Information om globala alternativ finns i Globala alternativ.
--force
, -f
Skriv över befintliga filer under återställning av en säkerhetskopia
- Standard:
false
- Accepterar inte ett värde
--file
En specifik filåterställningssökväg
- Accepterar ett värde
build:generate
ece-tools build:generate
Genererar alla filer som behövs för byggfasen.
Alternativ
Information om globala alternativ finns i Globala alternativ.
build:transfer
ece-tools build:transfer
Överför genererade filer till init-katalogen.
Alternativ
Information om globala alternativ finns i Globala alternativ.
cloud:config:create
ece-tools cloud:config:create <configuration>
Skapar en .magento.env.yaml
-fil med den angivna variabelkonfigurationen för build, deploy och post-deploy. Skriver över befintlig .magento.env.yaml
-fil.
Argument
configuration
Konfiguration i JSON-format
- Obligatoriskt
Alternativ
Information om globala alternativ finns i Globala alternativ.
cloud:config:update
ece-tools cloud:config:update <configuration>
Uppdaterar den befintliga .magento.env.yaml
-filen med den angivna konfigurationen. Skapar filen .magento.env.yaml
om den inte finns.
Argument
configuration
Konfiguration i JSON-format
- Obligatoriskt
Alternativ
Information om globala alternativ finns i Globala alternativ.
cloud:config:validate
ece-tools cloud:config:validate
Verifierar konfigurationsfilen .magento.env.yaml
Alternativ
Information om globala alternativ finns i Globala alternativ.
config:dump
ece-tools config:dumpdump
Dumpa konfigurationen för statisk innehållsdistribution.
Alternativ
Information om globala alternativ finns i Globala alternativ.
cron:disable
ece-tools cron:disable
Inaktivera alla Magento cron-processer och avsluta alla processer som körs.
Alternativ
Information om globala alternativ finns i Globala alternativ.
cron:enable
ece-tools cron:enable
Möjliggör Magento kundprocesser.
Alternativ
Information om globala alternativ finns i Globala alternativ.
cron:kill
ece-tools cron:kill
Avslutar alla Magento kundprocesser.
Alternativ
Information om globala alternativ finns i Globala alternativ.
cron:unlock
ece-tools cron:unlock [--job-code [JOB-CODE]]
Lås upp cron-jobb som fastnat i körläge.
Alternativ
Information om globala alternativ finns i Globala alternativ.
--job-code
Upplås genom att krona jobbkoden.
- Standard:
[]
- Accepterar flera värden
dev:generate:schema-error
ece-tools dev:generate:schema-error
Skapar dist/error-codes.md från filen schema.error.yaml.
Alternativ
Information om globala alternativ finns i Globala alternativ.
dev:git:update-composer
ece-tools dev:git:update-composer
Uppdaterar disposition för distribution från Git.
Alternativ
Information om globala alternativ finns i Globala alternativ.
env:config:show
ece-tools env:config:show [<variable>...]
Visa miljövariabler för kodad molnkonfiguration.
Argument
variable
Miljövariabler som ska visas, möjliga alternativ: tjänster, flöden, variabler
- Standard:
[]
- Array
Alternativ
Information om globala alternativ finns i Globala alternativ.
error:show
ece-tools error:show [-j|--json] [--] [<error-code>]
Visar information om fel med fel-ID eller information om alla fel från den senaste distributionen.
Argument
error-code
Felkod: Om kommandot inte skickas visas information om alla fel från den senaste distributionen
Alternativ
Information om globala alternativ finns i Globala alternativ.
--json
, -j
Används för att få resultat i JSON-format
- Standard:
false
- Accepterar inte ett värde
module:refresh
ece-tools module:refresh
Uppdaterar konfigurationen för att aktivera nya moduler.
Alternativ
Information om globala alternativ finns i Globala alternativ.
schema:generate
ece-tools schema:generate
Skapar schemafilen *.dist.
Alternativ
Information om globala alternativ finns i Globala alternativ.
wizard:ideal-state
ece-tools wizard:ideal-state
Verifierar det idealiska konfigurationstillståndet.
Alternativ
Information om globala alternativ finns i Globala alternativ.
wizard:master-slave
ece-tools wizard:master-slave
Verifierar konfigurationen av master-slave.
Alternativ
Information om globala alternativ finns i Globala alternativ.
wizard:scd-on-build
ece-tools wizard:scd-on-build
Verifierar SCD vid konfiguration av bygge.
Alternativ
Information om globala alternativ finns i Globala alternativ.
wizard:scd-on-demand
ece-tools wizard:scd-on-demand
Verifierar konfiguration av SCD vid behov.
Alternativ
Information om globala alternativ finns i Globala alternativ.
wizard:scd-on-deploy
ece-tools wizard:scd-on-deploy
Verifierar SCD vid distributionskonfiguration.
Alternativ
Information om globala alternativ finns i Globala alternativ.
wizard:split-db-state
ece-tools wizard:split-db-state
Verifierar möjligheten att dela DB och om DB redan delats eller inte.
Alternativ
Information om globala alternativ finns i Globala alternativ.