PHPackages                             wp-cli/shell-command - 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 &amp; Console](/categories/cli)
4. /
5. wp-cli/shell-command

ActiveWp-cli-package[CLI &amp; Console](/categories/cli)

wp-cli/shell-command
====================

Opens an interactive PHP console for running and testing PHP code.

v2.0.18(1mo ago)247.6M↓11.5%122MITPHPCI passing

Since Mar 17Pushed 1w ago5 watchersCompare

[ Source](https://github.com/wp-cli/shell-command)[ Packagist](https://packagist.org/packages/wp-cli/shell-command)[ Docs](https://github.com/wp-cli/shell-command)[ RSS](/packages/wp-cli-shell-command/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (10)Dependencies (6)Versions (34)Used By (2)

wp-cli/shell-command
====================

[](#wp-clishell-command)

Opens an interactive PHP console for running and testing PHP code.

[![Testing](https://github.com/wp-cli/shell-command/actions/workflows/testing.yml/badge.svg)](https://github.com/wp-cli/shell-command/actions/workflows/testing.yml) [![Code Coverage](https://camo.githubusercontent.com/6e78cf971336fab825ed1c23e9f710ef439a8709ae79ffaaa252685324b10c10/68747470733a2f2f636f6465636f762e696f2f67682f77702d636c692f7368656c6c2d636f6d6d616e642f6272616e63682f6d61696e2f67726170682f62616467652e737667)](https://codecov.io/gh/wp-cli/shell-command/tree/main)

Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)

Using
-----

[](#using)

```
wp shell [--basic] [--watch=] [--hook=]

```

`wp shell` allows you to evaluate PHP statements and expressions interactively, from within a WordPress environment. Type a bit of code, hit enter, and see the code execute right before you. Because WordPress is loaded, you have access to all the functions, classes and globals that you can use within a WordPress plugin, for example.

The `restart` command reloads the shell by spawning a new PHP process, allowing modified code to be fully reloaded. Note that this requires the `pcntl_exec()` function. If not available, the shell restarts in-process, which resets variables but doesn't reload PHP files.

**OPTIONS**

```
[--basic]
	Force the use of WP-CLI's built-in PHP REPL, even if the Boris or
	PsySH PHP REPLs are available.

[--watch=]
	Watch a file or directory for changes and automatically restart the shell.
	Only works with the built-in REPL (--basic).

[--hook=]
	Ensure that a specific WordPress action hook has fired before starting the shell.
	This validates that the preconditions associated with that hook are met.
	Only hooks that have already been triggered can be used (e.g., init, plugins_loaded, wp_loaded).
	---
	default: ''
	---

```

**EXAMPLES**

```
# Call get_bloginfo() to get the name of the site.
$ wp shell
wp> get_bloginfo( 'name' );
=> string(6) "WP-CLI"

# Restart the shell to reload code changes.
$ wp shell
wp> restart
Restarting shell in new process...
wp>

# Watch a directory for changes and auto-restart.
$ wp shell --watch=wp-content/plugins/my-plugin
wp> // Make changes to files in the plugin directory
Detected changes in wp-content/plugins/my-plugin, restarting shell...
wp>

# Start a shell, ensuring the 'init' hook has already fired.
$ wp shell --hook=init

# Start a shell in quiet mode, suppressing return value output.
$ wp shell --quiet
wp> $a = "hello";
wp>

```

Installing
----------

[](#installing)

This package is included with WP-CLI itself, no additional installation necessary.

To install the latest version of this package over what's included in WP-CLI, run:

```
wp package install git@github.com:wp-cli/shell-command.git

```

Contributing
------------

[](#contributing)

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.

### Reporting a bug

[](#reporting-a-bug)

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should [search existing issues](https://github.com/wp-cli/shell-command/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/shell-command/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).

### Creating a pull request

[](#creating-a-pull-request)

Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/shell-command/issues/new) to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See "[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)" for details specific to working on this package locally.

### License

[](#license)

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

Support
-------

[](#support)

GitHub issues aren't for general support questions, but there are other venues you can try:

*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

###  Health Score

68

—

FairBetter than 99% of packages

Maintenance96

Actively maintained with recent releases

Popularity56

Moderate usage in the ecosystem

Community32

Small or concentrated contributor base

Maturity74

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~138 days

Recently: every ~244 days

Total

25

Last Release

38d ago

Major Versions

v1.0.5 → v2.0.02018-08-05

### Community

Maintainers

![](https://www.gravatar.com/avatar/4b5740d002b5556abcceed36e016c8f8ba6f533eefef6107b3c60a830704993b?d=identicon)[danielbachhuber](/maintainers/danielbachhuber)

![](https://www.gravatar.com/avatar/6dde7f578e5530884238e7173f768ae3a890b6d66eb99262a82f2c494a1b67d4?d=identicon)[schlessera](/maintainers/schlessera)

---

Top Contributors

[![danielbachhuber](https://avatars.githubusercontent.com/u/36432?v=4)](https://github.com/danielbachhuber "danielbachhuber (479 commits)")[![scribu](https://avatars.githubusercontent.com/u/225715?v=4)](https://github.com/scribu "scribu (207 commits)")[![schlessera](https://avatars.githubusercontent.com/u/83631?v=4)](https://github.com/schlessera "schlessera (112 commits)")[![scribu-commits](https://avatars.githubusercontent.com/u/282080004?v=4)](https://github.com/scribu-commits "scribu-commits (107 commits)")[![swissspidy](https://avatars.githubusercontent.com/u/841956?v=4)](https://github.com/swissspidy "swissspidy (42 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (14 commits)")[![szepeviktor](https://avatars.githubusercontent.com/u/952007?v=4)](https://github.com/szepeviktor "szepeviktor (8 commits)")[![NateWr](https://avatars.githubusercontent.com/u/2306629?v=4)](https://github.com/NateWr "NateWr (8 commits)")[![miya0001](https://avatars.githubusercontent.com/u/309946?v=4)](https://github.com/miya0001 "miya0001 (6 commits)")[![mwilliamson](https://avatars.githubusercontent.com/u/391876?v=4)](https://github.com/mwilliamson "mwilliamson (6 commits)")[![nyordanov](https://avatars.githubusercontent.com/u/192220?v=4)](https://github.com/nyordanov "nyordanov (5 commits)")[![JRGould](https://avatars.githubusercontent.com/u/1509647?v=4)](https://github.com/JRGould "JRGould (5 commits)")[![ernilambar](https://avatars.githubusercontent.com/u/2098823?v=4)](https://github.com/ernilambar "ernilambar (5 commits)")[![francescolaffi](https://avatars.githubusercontent.com/u/357331?v=4)](https://github.com/francescolaffi "francescolaffi (4 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (4 commits)")[![gitlost](https://avatars.githubusercontent.com/u/481982?v=4)](https://github.com/gitlost "gitlost (4 commits)")[![mpeshev](https://avatars.githubusercontent.com/u/328189?v=4)](https://github.com/mpeshev "mpeshev (4 commits)")[![wojsmol](https://avatars.githubusercontent.com/u/4176111?v=4)](https://github.com/wojsmol "wojsmol (3 commits)")[![clemens-tolboom](https://avatars.githubusercontent.com/u/371014?v=4)](https://github.com/clemens-tolboom "clemens-tolboom (3 commits)")[![hearvox](https://avatars.githubusercontent.com/u/275759?v=4)](https://github.com/hearvox "hearvox (3 commits)")

---

Tags

clidebuggerhacktoberfestpsyshshellwordpresswp-cliwp-cli-package

### Embed Badge

![Health badge](/badges/wp-cli-shell-command/health.svg)

```
[![Health](https://phpackages.com/badges/wp-cli-shell-command/health.svg)](https://phpackages.com/packages/wp-cli-shell-command)
```

###  Alternatives

[wp-cli/scaffold-command

Generates code for post types, taxonomies, blocks, plugins, child themes, etc.

1728.2M20](/packages/wp-cli-scaffold-command)[wp-cli/core-command

Downloads, installs, updates, and manages a WordPress installation.

5210.9M26](/packages/wp-cli-core-command)[wp-cli/entity-command

Manage WordPress comments, menus, options, posts, sites, terms, and users.

1059.5M77](/packages/wp-cli-entity-command)[wp-cli/i18n-command

Provides internationalization tools for WordPress projects.

11611.2M61](/packages/wp-cli-i18n-command)[wp-cli/extension-command

Manages plugins and themes, including installs, activations, and updates.

909.7M75](/packages/wp-cli-extension-command)[wp-cli/checksum-command

Verifies file integrity by comparing to published checksums.

338.1M12](/packages/wp-cli-checksum-command)

PHPackages © 2026

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