Shell interativo

O CLI SAPI fornece um shell interativo usando a opção -a se o PHP for compilado com a opção --with-readline. A partir do PHP 7.1.0 o shell interativo também está disponível no Windows, se a extensão readline estiver habilitada.

Usando o shell interativo você será capaz de escrever código PHP e executá-lo diretamente.

Exemplo #1 Executando código usando o shell interativo

$ php -a
Interactive shell

php > echo 5+8;
php > function addTwo($n)
php > {
php { return $n + 2;
php { }
php > var_dump(addtwo(2));
php >

O shell interativo também possui sugestões de complemento com tab para funções, constantes, nomes de classes, variáveis, chamadas para métodos estáticos e constantes de classe.

Exemplo #2 Sugestões de complemento com tab

Pressionar a tecla tab duas vezes quando tiver mais de uma sugestão de complemento resultará numa lista desses complementos.

php > strp[TAB][TAB]
strpbrk   strpos    strptime
php > strp

Quando existir apenas um possível complemento, pressionar a tecla tab uma vez irá completar o restante da mesma linha:

php > strpt[TAB]ime(

Complementos também funcionarão para nomes que forem definidos durante a mesma sessão do shell interativo:

php > $fooThisIsAReallyLongVariableName = 42;
php > $foo[TAB]ThisIsAReallyLongVariableName

O shell interativo armazena seu histórico que pode ser acessado usando as teclas para cima e para baixo. O histórico é salvo no arquivo ~/.php_history.

O CLI SAPI fornece as configurações do php.ini cli.pager e cli.prompt. A configuração cli.pager permite que um programa externo (como o less) aja como uma alternativa para a saída ao invés dela ser exibida diretamente na tela. A configuração cli.prompt faz com que seja possível alterar a saída php >.

Também é possível definir configurações php.ini no shell interativo usando uma notação abreviada.

Exemplo #3 Definindo configurações php.ini no shell interativo

A opção cli.prompt:

php > #cli.prompt=hello world :>
hello world :>

Usando crase é possível executar o PHP diretamente no terminal:

php > #cli.prompt=`echo date('H:i:s');` php >
15:49:35 php > echo 'hi';
15:49:43 php > sleep(2);
15:49:45 php >

Setando o paginador paraless:

php > #cli.pager=less
php > phpinfo();
(output displayed in less)
php >

A configuração cli.prompt suporta algumas sequências de escape:

Sequências de escape do cli.prompt
Sequência Descrição
\e Usada para adicionar cores ao terminal. Um exemplo pode ser \e[032m\v \e[031m\b \e[34m\> \e[0m
\v A versão do PHP.
\b Indica em qual bloco o PHP está. Por exemplo /* irá indicar que o PHP está dentro de um comentário de múltiplas linhas. O escopo externo será denominado por php.
\> Indica o caractere do terminal. Por padrão é >, mas pode alterar quando o shell estiver dentro de um bloco indeterminado ou de uma string. Possíveis caracteres são: ' " { ( >


Arquivos incluídos através de auto_prepend_file e auto_append_file são interpretados nesse modo porém com algumas restrições - Exemplo: funções devem ser definidas antes de sua chamada.

Modo interarativo

Se a extensão readline não estiver disponível, anteriormente ao PHP 8.1.0, chamar o CLI SAPI com a opção -a fornecia o modo interativo. Nesse modo, um script PHP completo deveria ser fornecido via STDIN, terminado por uma sequência de CRTL+d (POSIX) ou CTRL+z seguido de ENTER (Windows), para que o script seja avaliado. Isto é basicamente o mesmo que invocar CLI SAPI sem a opção -a.

A partir do PHP 8.1.0, chamar a CLI SAPI com a opção -a falhará na ausência da extensão readline.

add a note

User Contributed Notes 6 notes

Ryan P
11 years ago
Interactive Shell and Interactive Mode are not the same thing, despite the similar names and functionality.

If you type 'php -a' and get a response of 'Interactive Shell' followed by a 'php>' prompt, you have interactive shell available (PHP was compiled with readline support). If instead you get a response of 'Interactive mode enabled', you DO NOT have interactive shell available and this article does not apply to you.

You can also check 'php -m' and see if readline is listed in the output - if not, you don't have interactive shell.

Interactive mode is essentially like running php with stdin as the file input. You just type code, and when you're done (Ctrl-D), php executes whatever you typed as if it were a normal PHP (PHTML) file - hence you start in interactive mode with '<?php' in order to execute code.

Interactive shell evaluates every expression as you complete it (with ; or }), reports errors without terminating execution, and supports standard shell functionality via readline (history, tab completion, etc). It's an enhanced version of interactive mode that is ONLY available if you have the required libraries, and is an actual PHP shell that interprets everything you type as PHP code - using '<?php' will cause a parse error.

Finally, if you're running on Windows, you're probably screwed. From what I'm seeing in other comments here, you don't have readline, and without readline there is no interactive shell.
spencer at aninternetpresence dot net
12 years ago
In Windows, press Enter after your ending PHP tag and then hit Ctrl-Z to denote the end-of-file:

C:\>php -a
Interactive mode enabled

echo "Hello, world!";
Hello, world!

You can use the up and down arrows in interactive mode to recall previous code you ran.
3 years ago
When adding colours, don't forget that PHP uses the same 'readline' as Bash does, so it has the same need to wrap all colour codes in special marker characters.

If you simply add raw colour codes to the prompt, you will notice that long lines no longer get wrapped correctly -- Readline no longer knows how wide the prompt is.

To fix this, you need to start each colour code with an '0x01' byte (aka Ctrl-A aka SOH) and end it with the '0x02' byte (aka Ctrl-B aka STX). There are no escapes for these -- you have to literally put the control characters in your php-cli.ini.

For example:


// cli.prompt = <SOH>\e[1m<STX> PHP! \> <SOH>\e[m<STX>

echo "cli.prompt = \x01\\e[1m\x02 PHP! \x01\\e[m\x02\n";
6 years ago
For use interactive mode enabled on GNU/Linux on distros Debian/Ubuntu/LinuxMint you must install "php*-cli" and "php*-readline" packages from official repository.
>$sudo aptitude install php5-cli php5-readline

After that you can use interactive mode.
~ $ php -a
Interactive mode enabled

php >echo "hola mundo!\n";
hola mundo!
php >

I hope somebody help it!
13 years ago
Just a few more notes to add...

1) Hitting return does literally mean "execute this command". Semicolon to note end of line is still required. Meaning, doing the following will produce a parse error:

php > print "test"
php > print "asdf";

Whereas doing the following is just fine:

php > print "test"
php > ."asdf";

2) Fatal errors may eject you from the shell:

name@local:~$ php -a
php > asdf();

Fatal Error: call to undefined function...

3) User defined functions are not saved in history from shell session to shell session.

4) Should be obvious, but to quit the shell, just type "quit" at the php prompt.

5) In a sense, the shell interaction can be thought of as linearly following a regular php file, except it's live and dynamic. If you define a function that you've already defined earlier in your current shell, you will receive a fatal "function already defined" error only upon entering that closing bracket. And, although "including" a toolset of custom functions or a couple of script addon php files is rather handy, should you edit those files and wish to "reinclude" it again, you'll cause a fatal "function x already defined" error.
5 years ago
If you delete your "~/.php_history", you MUST re-create the file manually!

Because after I deleted my history file, "php -a" (interactive mode) never saved any history anymore.

It only started working after I ran "touch ~/.php_history" to create an empty file. From then on, PHP is saving history again!

I thought this was a bit unusual. Normally, applications recreate their history files themselves. But just be aware of the fact that PHP works this way instead, guys and girls! :-)
To Top