README

A bundle to use the PHP REPL PsySH with Symfony. Learn more at psysh.org.

Requirements: PHP 8.1+, Symfony 6.4+

What does it do?

Loads PsySH with the full application container
Exposes the following variables out of the box:

Variable	Description
`$container`	The Symfony service container (TestContainer)
`$kernel`	The application kernel
`$parameters`	All container parameters
`$self`	The PsySH shell instance itself

You can also add your own variables via configuration.

Documentation

Install

Install via Composer:

composer require --dev xman12/psysh-bundle

With Symfony Flex, the bundle is registered automatically in config/bundles.php. If you manage bundles manually, add it only for dev/test environments:

// config/bundles.php
return [
    // ...
    xman12\PsyshBundle\PsyshBundle::class => ['dev' => true, 'test' => true],
];

Usage

Interactive shell

bin/console psysh

Once inside the shell, you have immediate access to $container, $kernel, $parameters and $self.

Inline breakpoints

Place a psysh() call anywhere in your code to drop into an interactive shell at that point:

use function xman12\PsyshBundle\psysh;

class OrderService
{
    public function process(Order $order): void
    {
        // Drop into a shell with $order available and the current object bound
        psysh(['order' => $order], $this);
    }
}

Go further with the docs.

Customize PsySH

Adding a custom command

Tag any class extending Psy\Command\Command with psysh.command. With autoconfigure enabled (the default in Symfony 6.4), no explicit tag is needed — the bundle detects these classes automatically:

# config/services.yaml
services:
    _defaults:
        autoconfigure: true
        autowire: true

    Acme\Shell\MyCommand: ~

To add the tag explicitly:

services:
    Acme\Shell\MyCommand:
        tags:
            - { name: psysh.command }

The bundle autoconfigures any service that inherits from Psy\Command\Command or Psy\Command\ReflectingCommand.

Adding custom variables

Declare extra shell variables in config/packages/dev/psysh.yaml:

# config/packages/dev/psysh.yaml
psysh:
    variables:
        foo: bar
        router: "@router"
        some: [thing, else]
        debug: "%kernel.debug%"

Variables can be:

scalar values
container parameter references (e.g. %kernel.debug%)
service references (prefixed with @, e.g. "@router")
arrays

After running bin/console psysh, inspect available variables with ls:

>>> ls
Variables: $container, $kernel, $parameters, $self, $foo, $router, $some, $debug

Credits

This bundle is developed by Théo FIDRY. This project has been made possible thanks to:

Justin Hileman: author of PsySH and all the contributors
Adrian Palmer: gave the lead for porting PsySH to Symfony

xman12 / psysh-bundle

Maintainers

Package info

Fund package maintenance!

Statistics

Security