Commands
To run a command, enter its name at the prompt, followed by any arguments that it accepts:
>>> $a = $b = 'c'
=> "c"
>>> ls -al
Variables:
$a "c"
$b "c"
$_ "c"
>>>
In the extremely unlikely case that your command name conflicts with some PHP code you actually want to run, you can prefix your input with a semicolon to prevent commands from running:
>>> const help = 'HELP ME!'
=> true
>>> help
help Show a list of commands. Type `help [foo]` for information about [foo]. Aliases: ?
ls List local, instance or class variables, methods and constants. Aliases: list, dir
dump Dump an object or primitive.
doc Read the documentation for an object, class, constant, method or property. Aliases: rtfm, man
show Show the code for an object, class, constant, method or property.
...
>>> ;help
=> "HELP ME!"
>>>
The help command will print a list of all commands currently available in PsySH, along with a short description of what each command does:
>>> help
help Show a list of commands. Type `help [foo]` for information about [foo]. Aliases: ?
ls List local, instance or class variables, methods and constants. Aliases: list, dir
dump Dump an object or primitive.
doc Read the documentation for an object, class, constant, method or property. Aliases: rtfm, man
show Show the code for an object, class, constant, method or property.
...
>>>
The help command can also show more information—including usage and examples—about a specific command:
>>> help dump
Usage:
dump [--depth DEPTH] [-a|--all] [--] <target>
Arguments:
target A target object or primitive to dump.
Options:
--depth Depth to parse (default: 10)
--all (-a) Include private and protected methods and properties.
Help:
Dump an object or primitive.
This is like var_dump but way awesomer.
e.g.
>>> dump $_
>>> dump $someVar
>>>
-
buffer— Show (or clear) the contents of the code input buffer. -
clear— Clear the Psy Shell screen. -
doc— Read the documentation for an object, class, constant, method or property. -
dump— Dump an object or primitive. -
edit— Open an external editor. Afterwards, get produced code in input buffer. -
exit— End the current session and return to caller. -
help— Show a list of commands. Typehelp [foo]for information about [foo]. -
history— Show the Psy Shell history. -
ls— List local, instance or class variables, methods and constants. -
show— Show the code for an object, class, constant, method or property. -
sudo— Evaluate PHP code, bypassing visibility restrictions. -
throw-up— Throw an exception out of the Psy Shell. -
timeit— Profiles with a timer. -
trace— Show the current call stack. -
whereami— Show where you are in the code. -
wtf— Show the backtrace of the most recent exception.
Windows