Extrair Backups na linha de comandos

Este artigo explica como extrair um backup do WP Staging na linha de comandos com a ferramenta wpstaging cli. Se tiver dificuldades a trabalhar na linha de comandos, pode utilizar outra ferramenta chamada WP Staging restore tool para realizar a mesma tarefa com uma interface gráfica.

wpstaging cli é uma poderosa ferramenta de linha de comandos com elevado desempenho, concebida para processar ficheiros de backup do WP Staging na linha de comandos em qualquer dos principais sistemas operativos.

Com esta ferramenta, pode extrair, normalizar e inspecionar o conteúdo dos ficheiros de backup .wpstg criados pelo plugin WP Staging. Este extrator autónomo é desenvolvido em Go, garantindo uma velocidade e eficiência excecionais, e funciona de forma independente do WordPress.

A ferramenta de linha de comandos `wp-staging-cli` faz parte dos planos WP Staging Developer e Agency e pode ser transferida em GitHub.

Contents

Principais funcionalidades
- Benchmark de desempenho
Instalação
- Passo 1: Transferir os executáveis
Artigos relacionados

Principais funcionalidades

Extrair ficheiros de backup e base de dados: aceda a todos os conteúdos dos ficheiros de backup .wpstg.
Normalização da base de dados: normalize os ficheiros da base de dados dentro do backup.
Exportação de metadados: extraia e mostre os metadados do ficheiro de backup.
Exportação de índice e cabeçalho: obtenha informações de índice e cabeçalho do ficheiro de backup.

Benchmark de desempenho

wp-staging-cli é excecionalmente rápido. Por exemplo, consegue extrair um backup de 20 GB em menos de 36 segundos num AMD Ryzen™ 7 PRO 7840U com um SSD rápido a executar Ubuntu 22.04.

Instalação

Passo 1: Transferir os executáveis

Transfira os ficheiros executáveis para Windows, Linux e Mac OS aqui.
Extraia o ficheiro zip e selecione o binário adequado ao seu sistema operativo a partir da pasta build.
(Opcional) Mova o binário wp-staging-cli para um diretório no seu PATH para um acesso fácil. Por exemplo, em Linux:

ShellScript

mv wp-staging-cli /usr/local/bin/

mv wp-staging-cli /usr/local/bin/

Instruções de utilização

Para executar o wp-staging-cli, utilize o seguinte comando:

ShellScript

wp-staging-cli [options] <backupfile.wpstg>

wp-staging-cli [options] <backupfile.wpstg>

Argumentos

<backupfile.wpstg>: caminho para o ficheiro de backup do WP Staging a processar. Este argumento é obrigatório.

As opções e os argumentos do comando podem ser utilizados por qualquer ordem.

As opções podem ter um hífen único ‘-‘ ou um prefixo de hífen duplo ‘–‘.
As opções com valores podem ser indicadas com ou sem ‘=’.

Opções

ShellScript

Commands:
extract - Extract items from the backup. Default if no command is specified.
restore - Restore the backup file.
help - Display all help message.

Arguments:
backupfile.wpstg - Path to the WP Staging backup file that will be processed. This argument is mandatory.

General Options:
-l, --license=<licensekey> - WP Staging Pro License Key. Required to access the backup file.
Alternatively, use the `WPSTGPRO_LICENSE` environment variable.
-o, --outputdir=<path> - Specify the extraction directory path where processed files will be stored. Default: "./wp-staging-cli-output".
-n, --normalizedb - Normalize database files during the `extract` process.
This will replace all WP Staging specific placeholders and allows the sql file to be imported by
any regular db admin tool.

--workingdir=<path> - Specify the working directory path where config-related files will be stored. Default: "~/.wp-staging-cli".
--skip-config - Don't reads command options from the configuration file located at "~/.wp-staging-cli/wp-staging-cli.conf".
--siteurl=<siteurl> - Specify a new Site URL.
--db-prefix=<prefix> - Specify a new database table prefix.
--overwrite=<yes|no> - Overwrite the target directory during `extract` and `restore` operations. Default: "yes".
--verify - Verify the integrity of the extracted file.
--yes - Automatically answers "yes" to confirmation prompts.
--confirm-timeout=<num> - Timeout duration (in seconds) for awaiting a "yes" response at confirmation prompts. Default: 30 seconds.
--skip-extract - Don't extract files and use previously extracted and existing files for `restore` process.
For use case, when restore failed, the process can be continued without first extracting all files again.

-or, --only-wproot - Process only the 'wp root' item in the backup.
-ow, --only-wpcontent - Process only the 'wp-content' item in the backup.
-op, --only-plugins - Process only the 'plugins' item in the backup.
-ot, --only-themes - Process only the 'themes' item in the backup.
-om, --only-muplugins - Process only the 'mu-plugins' item in the backup.
-ou, --only-uploads - Process only the 'uploads' item in the backup.
-ol, --only-languages - Process only the 'languages' item in the backup.
-od, --only-dbfile - Process only the database file in the backup.
-oe, --only-dropins - Process only the dropins file in the backup.
-of, --only-file=<string> - Process only items that match the specified string.

-sr, --skip-wproot - Skip processing the 'wp root' item in the backup.
-sw, --skip-wpcontent - Skip processing the 'wp-content' item in the backup.
-sp, --skip-plugins - Skip processing the 'plugins' item in the backup.
-st, --skip-themes - Skip processing the 'themes' item in the backup.
-sm, --skip-muplugins - Skip processing the 'mu-plugins' item in the backup.
-su, --skip-uploads - Skip processing the 'uploads' item in the backup.
-sl, --skip-languages - Skip processing the 'languages' item in the backup.
-sd, --skip-dbfile - Skip processing the database file in the backup.
-se, --skip-dropins - Skip processing the dropins file in the backup.
-sf, --skip-file=<string> - Skip processing items that match the specified string.

-dm, --dump-metadata - Display backup metadata from the backup file.
-di, --dump-index=<data> - Display backup index from the backup file. Use 'data' to show additional information.
-dh, --dump-header - Display backup header from the backup file.
-do, --dump-options - Display the command options that have been parsed.

-d, --debug - Display debug message.
-q, --quiet - Suppress output of processed backup items.
-v, --version - Display version information.
-h, --help - Display all help message.

Restore Options:
-p, --path=<path> - Specify the WordPress root path for restoration. Default: "./".
-wd, --overwrite-db=<yes|no> - Remove database tables not present in the backup. Default: "yes".
-wr, --overwrite-wproot=<yes|no> - Remove files in the WordPress root path that are not in the backup or part of WordPress core. Default: "no".
--db-innodb-strict-mode - Enable InnoDB strict mode if needed. By default, it is turned off during database restoration.
--db-file=<file> - Use the extracted backup SQL file to resume database restoration in case of failure.
--db-insert-batch-size=<num> - Number of queries to batch in a single insert operation. Default: 1000.
--db-insert-multi=<yes|no> - Use multi-row INSERT statements per query to improve performance. Default "yes".

Restore DB Options:
This option overrides the DB-related configuration parsed from the wp-config.php file.
--db-host=<string> - Database Host.
--db-name=<string> - Database Name.
--db-user=<string> - Database User.
--db-pass=<string> - Database Password.
--db-socket=<file> - MySQL socket file path.
--db-charset=<string> - Database charset.
--db-collate=<string> - Database collate.
--db-ssl-ca-cert=<file> - SSL CA file path.
--db-ssl-cert=<file> - SSL certificate file path.
--db-ssl-key=<file> - SSL key file path.
--db-ssl-mode=<mode> - Connects to the database with SSL mode "skip-verify" or "preferred". Default: "skip-verify".

  Commands:
  extract - Extract items from the backup. Default if no command is specified.
  restore - Restore the backup file.
  help    - Display all help message.

Arguments:
  backupfile.wpstg  - Path to the WP Staging backup file that will be processed. This argument is mandatory.

General Options:
  -l,  --license=<licensekey>       - WP Staging Pro License Key. Required to access the backup file.
                                      Alternatively, use the `WPSTGPRO_LICENSE` environment variable.
  -o,  --outputdir=<path>           - Specify the extraction directory path where processed files will be stored. Default: "./wp-staging-cli-output".
  -n,  --normalizedb                - Normalize database files during the `extract` process.
                                      This will replace all WP Staging specific placeholders and allows the sql file to be imported by
                                      any regular db admin tool.

       --workingdir=<path>          - Specify the working directory path where config-related files will be stored. Default: "~/.wp-staging-cli".
       --skip-config                - Don't reads command options from the configuration file located at "~/.wp-staging-cli/wp-staging-cli.conf".
       --siteurl=<siteurl>          - Specify a new Site URL.
       --db-prefix=<prefix>         - Specify a new database table prefix.
       --overwrite=<yes|no>         - Overwrite the target directory during `extract` and `restore` operations. Default: "yes".
       --verify                     - Verify the integrity of the extracted file.
       --yes                        - Automatically answers "yes" to confirmation prompts.
       --confirm-timeout=<num>      - Timeout duration (in seconds) for awaiting a "yes" response at confirmation prompts. Default: 30 seconds.
       --skip-extract               - Don't extract files and use previously extracted and existing files for `restore` process.
                                      For use case, when restore failed, the process can be continued without first extracting all files again.

  -or, --only-wproot                - Process only the 'wp root' item in the backup.
  -ow, --only-wpcontent             - Process only the 'wp-content' item in the backup.
  -op, --only-plugins               - Process only the 'plugins' item in the backup.
  -ot, --only-themes                - Process only the 'themes' item in the backup.
  -om, --only-muplugins             - Process only the 'mu-plugins' item in the backup.
  -ou, --only-uploads               - Process only the 'uploads' item in the backup.
  -ol, --only-languages             - Process only the 'languages' item in the backup.
  -od, --only-dbfile                - Process only the database file in the backup.
  -oe, --only-dropins               - Process only the dropins file in the backup.
  -of, --only-file=<string>         - Process only items that match the specified string.

  -sr, --skip-wproot                - Skip processing the 'wp root' item in the backup.
  -sw, --skip-wpcontent             - Skip processing the 'wp-content' item in the backup.
  -sp, --skip-plugins               - Skip processing the 'plugins' item in the backup.
  -st, --skip-themes                - Skip processing the 'themes' item in the backup.
  -sm, --skip-muplugins             - Skip processing the 'mu-plugins' item in the backup.
  -su, --skip-uploads               - Skip processing the 'uploads' item in the backup.
  -sl, --skip-languages             - Skip processing the 'languages' item in the backup.
  -sd, --skip-dbfile                - Skip processing the database file in the backup.
  -se, --skip-dropins               - Skip processing the dropins file in the backup.
  -sf, --skip-file=<string>         - Skip processing items that match the specified string.

  -dm, --dump-metadata              - Display backup metadata from the backup file.
  -di, --dump-index=<data>          - Display backup index from the backup file. Use 'data' to show additional information.
  -dh, --dump-header                - Display backup header from the backup file.
  -do, --dump-options               - Display the command options that have been parsed.

  -d,  --debug                      - Display debug message.
  -q,  --quiet                      - Suppress output of processed backup items.
  -v,  --version                    - Display version information.
  -h,  --help                       - Display all help message.

Restore Options:
  -p,  --path=<path>                - Specify the WordPress root path for restoration. Default: "./".
  -wd, --overwrite-db=<yes|no>      - Remove database tables not present in the backup. Default: "yes".
  -wr, --overwrite-wproot=<yes|no>  - Remove files in the WordPress root path that are not in the backup or part of WordPress core. Default: "no".
       --db-innodb-strict-mode      - Enable InnoDB strict mode if needed. By default, it is turned off during database restoration.
       --db-file=<file>             - Use the extracted backup SQL file to resume database restoration in case of failure.
       --db-insert-batch-size=<num> - Number of queries to batch in a single insert operation. Default: 1000.
       --db-insert-multi=<yes|no>   - Use multi-row INSERT statements per query to improve performance. Default "yes".

Restore DB Options:
  This option overrides the DB-related configuration parsed from the wp-config.php file.
       --db-host=<string>           - Database Host.
       --db-name=<string>           - Database Name.
       --db-user=<string>           - Database User.
       --db-pass=<string>           - Database Password.
       --db-socket=<file>           - MySQL socket file path.
       --db-charset=<string>        - Database charset.
       --db-collate=<string>        - Database collate.
       --db-ssl-ca-cert=<file>      - SSL CA file path.
       --db-ssl-cert=<file>         - SSL certificate file path.
       --db-ssl-key=<file>          - SSL key file path.
       --db-ssl-mode=<mode>         - Connects to the database with SSL mode "skip-verify" or "preferred". Default: "skip-verify".

Exemplos:

ShellScript

wp-staging-cli --license=WPSTGPRO_LICENSE --outputdir=./wpstgbackup backup.wpstg
wp-staging-cli --license=WPSTGPRO_LICENSE --normalizedb --dbprefix=newprefix --siteurl=https://example.com backup.wpstg

wp-staging-cli --license=WPSTGPRO_LICENSE --outputdir=./wpstgbackup backup.wpstg
wp-staging-cli --license=WPSTGPRO_LICENSE --normalizedb --dbprefix=newprefix --siteurl=https://example.com backup.wpstg

Com as opções curtas:

ShellScript

wp-staging-cli -l WPSTGPRO_LICENSE -o ./wpstgbackup backup.wpstg
wp-staging-cli -l WPSTGPRO_LICENSE -n -dp newprefix -su https://example.com backup.wpstg

wp-staging-cli -l WPSTGPRO_LICENSE -o ./wpstgbackup backup.wpstg
wp-staging-cli -l WPSTGPRO_LICENSE -n -dp newprefix -su https://example.com backup.wpstg

Definir a chave de licença através de uma variável de ambiente

O extrator autónomo requer uma licença WP Staging Pro ativa (plano Agency ou Developer).
Por conveniência, pode definir a chave de licença através de uma variável de ambiente:

Em sistemas baseados em Unix:

ShellScript

export WPSTGPRO_LICENSE=WPSTGPRO_LICENSE_KEY

export WPSTGPRO_LICENSE=WPSTGPRO_LICENSE_KEY

No terminal do Windows:

PowerShell

set WPSTGPRO_LICENSE=WPSTGPRO_LICENSE_KEY

set WPSTGPRO_LICENSE=WPSTGPRO_LICENSE_KEY

Contribuir para o wp-staging-cli

Aceitamos contribuições para o wp-staging-cli! Se tiver sugestões, relatórios de bugs ou quiser contribuir com código, abra uma issue no repositório do GitHub.

Extrair Backups na linha de comandos em Linux, MacOS ou Windows

Principais funcionalidades

Benchmark de desempenho

Instalação

Passo 1: Transferir os executáveis

Instruções de utilização

Argumentos

Definir a chave de licença através de uma variável de ambiente

Contribuir para o wp-staging-cli

Autor: Rene Hermenau

Categories

Principais funcionalidades

Benchmark de desempenho

Instalação

Passo 1: Transferir os executáveis

Instruções de utilização

Argumentos

Definir a chave de licença através de uma variável de ambiente

Contribuir para o wp-staging-cli

Artigos relacionados

Autor: Rene Hermenau

Categories