PHPackages                             lolautruche/ezsh - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. lolautruche/ezsh

ActiveLibrary[CLI & Console](/categories/cli)

lolautruche/ezsh
================

Interactive debug shell for eZ Publish 5+ apps. Uses PsySH.

v2.0(8y ago)75.5k5MITPHP

Since Sep 2Pushed 8y ago4 watchersCompare

[ Source](https://github.com/lolautruche/ezsh)[ Packagist](https://packagist.org/packages/lolautruche/ezsh)[ RSS](/packages/lolautruche-ezsh/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (7)Dependencies (2)Versions (10)Used By (0)

eZ Debug Shell
==============

[](#ez-debug-shell)

eZ Debug Shell is an interactive CLI debugger for eZ Platform. It is built on top of [PsySH](http://psysh.org) and thus acts as a [*Read-eval-print-loop* (aka **repl**)](http://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop).

It allows you to debug live code in the context of an eZ Publish application, avoiding to create CLI commands.

Install
-------

[](#install)

### Global install (recommended)

[](#global-install-recommended)

```
composer global require lolautruche/ezsh:^2.0
```

> `v1.0` is compatible with eZ Publish 5.3+ while `v2.0` is only compatible with eZ Platform.

This will install `ezsh` executable into the ~/.composer/vendor/bin folder.

> For `ezsh` to work properly without hassle, ensure you have `~.composer/vendor/bin` in your `$PATH`:
>
> ```
> export PATH=~/.composer/vendor/bin
> ```

### Project install

[](#project-install)

You can install `ezsh` binary in your eZ project with Composer:

```
composer require lolautruche/ezsh:^2.0
```

Usage
-----

[](#usage)

```
Usage:
  ezsh [--siteaccess=] [--env=] [--debug] [--version] [--help] [user_login]

Options:
  --siteaccess    -s SiteAccess to use (e.g. ezdemo_site). If not provided, fallbacks to configured default SiteAccess.
  --env           -e Environment to use (defaults to "dev").
  --debug         -d Use debugging if provided. Debug is always on with "dev" environment.
  --help          -h Display this help message.
  --version       -v Display the PsySH version.
  --config        -c Use an alternate PsySH config file location.

  user_login      User login (i.e. username) to use to authenticate against the repository. If not provided, anonymous user will be used.
```

> **Important:** To be able to use `ezsh`, **you first need to be in your eZ project root**:

```
cd /my/ezpublish/root
ezsh --siteaccess=my_siteaccess
```

This will display something like:

```
Debugging eZ Publish using 'my_siteaccess' SiteAccess, in 'dev' environment.
Psy Shell v0.8.9 (PHP 7.0.19 — cli) by Justin Hileman
>>>
```

Starting from here, you'll be able to evaluate any kind of code in the context of your project.

### Available variables

[](#available-variables)

Some variables are already set for you, like the service container, the ConfigResolver and the Repository:

VariableDescription`$container`Instance of Symfony ServiceContainer. Get your services with it`$kernel`Instance of your `EzPublishKernel``$repository`Instance of the eZ Content repository (to use API)`$contentService`The ContentService`$contentTypeService`The ContentTypeService`$locationService`The LocationService`$searchService`The SearchService`$userService`The UserService`$configResolver`The ConfigResolver (to get SiteAccess aware settings)### Example

[](#example)

> From the debug shell, you can define any kind of functions, loops, conditions...
> For more information see [PsySH documentation](http://psysh.org).

```
Debugging eZ Platform using 'default' SiteAccess, in 'dev' environment.

Psy Shell v0.1.12 (PHP 5.5.15 — cli) by Justin Hileman
>>> $repository
=>  {}
>>> $contentInfo = $contentService->loadContentInfo(2926);
=> >> $configResolver->getParameter('languages');
=> [
       "eng-GB"
   ]
```

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 86.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~148 days

Recently: every ~185 days

Total

8

Last Release

3232d ago

Major Versions

v0.2.0 → 1.0.x-dev2017-07-12

v1.0 → v2.02017-07-12

### Community

Maintainers

![](https://www.gravatar.com/avatar/332d9fbb8a1a71e3c50adb2542bfd8a60756945d02103afb4eb395af9c0d3929?d=identicon)[lolautruche](/maintainers/lolautruche)

---

Top Contributors

[![lolautruche](https://avatars.githubusercontent.com/u/313528?v=4)](https://github.com/lolautruche "lolautruche (50 commits)")[![bobthecow](https://avatars.githubusercontent.com/u/53660?v=4)](https://github.com/bobthecow "bobthecow (4 commits)")[![wizhippo](https://avatars.githubusercontent.com/u/1456102?v=4)](https://github.com/wizhippo "wizhippo (3 commits)")[![nicolas-grekas](https://avatars.githubusercontent.com/u/243674?v=4)](https://github.com/nicolas-grekas "nicolas-grekas (1 commits)")

---

Tags

consoledebugREPLshellinteractiveezpublish

### Embed Badge

![Health badge](/badges/lolautruche-ezsh/health.svg)

```
[![Health](https://phpackages.com/badges/lolautruche-ezsh/health.svg)](https://phpackages.com/packages/lolautruche-ezsh)
```

###  Alternatives

[psy/psysh

An interactive shell for modern PHP.

9.8k545.6M719](/packages/psy-psysh)[kevinlebrun/colors.php

Colors for PHP CLI scripts

3426.7M45](/packages/kevinlebrun-colorsphp)[buggregator/trap

A simple and powerful tool for debugging PHP applications.

2591.7M40](/packages/buggregator-trap)[alecrabbit/php-console-spinner

Extremely flexible spinner for \[async\] php cli applications

24032.0k2](/packages/alecrabbit-php-console-spinner)[maximebf/consolekit

Library to create command line utilities

114104.4k9](/packages/maximebf-consolekit)[ramsey/composer-repl

A REPL for PHP built into Composer.

105111.1k24](/packages/ramsey-composer-repl)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)