WP-CLI The command line interface for WordPress

WP-CLI é um conjunto de linhas de comando para gerenciar instalações WordPress. Você pode atualizar plugins, configurar instalações multisite e muito mais, sem utilizar um navegador web.

Para manter-se atualizado, siga @wpcli no Twitter ou inscreva-se em nossa newsletter.

Build Status Dependency Status Average time to resolve an issue Percentage of issues still open

Links rápidos: Usando | Instalando | Suporte | Extendendo | Contribuindo | Créditos

Usando

O objetivo da WP-CLI é fornecer uma interface em linha de comando para qualquer ação que você queira executar na administração do WordPress. Por exemplo wp plugin install --activate (doc) permite a instação e ativação de um plugin WordPress:

$ wp plugin install rest-api --activate
Installing WordPress REST API (Version 2) (2.0-beta13)
Downloading install package from https://downloads.wordpress.org/plugin/rest-api.2.0-beta13.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating 'rest-api'...
Success: Plugin 'rest-api' activated.

WP-CLI também inclui muitos comandos para ações que não são possíveis através da administração do WordPress. Por exemplo, wp transient delete --all (doc) permite deletar uma ou todas as transients:

$ wp transient delete --all
Success: 34 transients deleted from the database.

Para uma introdução mais completa sobre como usar a WP-CLI, leia o Guia rápido.

Já se sente confortável com o básico? Vá para a lista completa de comandos para obter informações detalhadas na gestão de temas e plugins, importação e exportação de dados, operações de busca e substituição no banco de dados e muito mais.

Instalando

Realizar o download do arquivo Phar é o método de instalação que recomendamos. Caso precise, nossa documentação para métodos alternativos de instação.

Antes instalar a WP-CLI, certifique-se que seu ambiente possua os requesitos mínimos:

Após verificar os requesitos, faça o download do arquivo wp-cli.phar usando wget ou curl:

$ curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

Em seguida, verifique se está funcionando:

$ php wp-cli.phar --info

Digite wp para utilizar WP-CLI a partir da linha de comando, torne o arquivo executável e mova-o para algum diretório presente em sua variável de ambiente PATH. For example:

$ chmod +x wp-cli.phar
$ sudo mv wp-cli.phar /usr/local/bin/wp

Se WP-CLI foi instalado com sucesso, ao executar wp --info você deverá ver algo como:

$ wp --info
PHP binary:    /usr/bin/php5
PHP version:    5.5.9-1ubuntu4.14
php.ini used:   /etc/php5/cli/php.ini
WP-CLI root dir:        /home/wp-cli/.wp-cli
WP-CLI packages dir:    /home/wp-cli/.wp-cli/packages/
WP-CLI global config:   /home/wp-cli/.wp-cli/config.yml
WP-CLI project config:
WP-CLI version: 0.23.0

Atualizando

WP-CLI pode ser atualizado com wp cli update (doc), ou repetindo os passos da instalação.

Quer viver a vida no limite? Execute wp cli update --nightly para usar a última compilação de desenvolvimento da WP-CLI. Essa versão é bastante estável para utilizar em seu ambiente de desenvolvimento, e sempre inclui as melhores e mais atuais funcionalidades da WP-CLI.

Auto-completar

WP-CLI também acompanha scripts de auto-completar para Bash ou ZSH. Faça o download wp-completion.bash e carregue o arquivo para ~/.bash_profile:

source /FULL/PATH/TO/wp-completion.bash

Não se esqueça de executar source ~/.bash_profile em seguida.

Suporte

Os colaboradores do projeto WP-CLI fazem seu melhor para rsponder a todos os problemas assim que possível. Para que possamos fazer melhor uso do tempo dos voluntários, verifique se já existe uma resposta para sua pergunta em umas das fontes abaixo:

Caso não encontre uma resposta na fontes existentes, fique a vontade para abrir uma questão com sua dúvida.

Se você possui uma conta WordPress.org, considere se inscrever no canal #cli no Slack do WordPress.org.

Extendendo

Um commando é uma unidade singular de uma funcionalidade WP-CLI. wp plugin install (doc) é um comando. wp plugin activate (doc) é outro.

A WP-CLI suporta o registro de qualquer classe ou função como um comando, lendo os detalhes de uso através de PHPdoc Callback. WP_CLI::add_command() (doc) é utilizado para registo de comandos internos e de terceiros.

/**
 * Delete an option from the database.
 *
 * Returns an error if the option didn't exist.
 *
 * ## OPTIONS
 *
 * <key>
 * : Key for the option.
 *
 * ## EXAMPLES
 *
 *     $ wp option delete my_option
 *     Success: Deleted 'my_option' option.
 */
$delete_option_cmd = function( $args ) {
	list( $key ) = $args;

	if ( ! delete_option( $key ) ) {
		WP_CLI::error( "Could not delete '$key' option. Does it exist?" );
	} else {
		WP_CLI::success( "Deleted '$key' option." );
	}
};
WP_CLI::add_command( 'option delete', $delete_option_cmd );

WP-CLI vem com muitos comandos. Criar um comando personalizado para WP-CLi é mais fácil do que parece. Leia o livro de receitas de comandos para aprender mais. Procure a documentação de API interna para descobrir a variedade de funcionalidades úteis que você pode utilizar no seu comando personalizado para WP-CLI.

Contribuindo

Seja bem vindo e obrigado!

Nós agradecemos sua iniciativa em contribuir com a WP-CLI. É por sua causa e a comunidade a sua volta, que a WP-CLI se tornou um grande projeto.

Contribuir não é limitado a somente código. Te encorajamos a contribuir da maneira que melhor se encaixe em suas habilidades, escrevendo tutoriais, com demonstrações em palestras locais, ajudar outros usuários respondendo suas dúvidas no suporte, ou revisando nossa documentação.

De uma olhada com atenção nesse guia. Seguindo esses passos você estará respeitando o tempo dos outros colaboradoes. Por sua vez, eles farão o melhor para retribuir esse respeito no trabalho com você, nos diferentes fusos horários e em todo o mundo.

Criadores e liderança

WP-CLI foi criado e mantido por:

Saiba mais sobre os projetos de governança e veja a lista completa dos colaboradores.

Créditos

Além das bibliotecas especificadas em composer.json, utilizamos o código ou idéias dos projetos abaixos: