PHPackages                             pstaender/kirby-console - 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. pstaender/kirby-console

ActiveLibrary

pstaender/kirby-console
=======================

kirby REPL

0.0.9(1y ago)01.1k↓100%MITPHPPHP &gt;=8.0

Since Dec 16Pushed 1y ago1 watchersCompare

[ Source](https://github.com/pstaender/kirby-console)[ Packagist](https://packagist.org/packages/pstaender/kirby-console)[ RSS](/packages/pstaender-kirby-console/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (10)Used By (0)

Kirby Console
=============

[](#kirby-console)

Your REPL for Kirby CMS projects
--------------------------------

[](#your-repl-for-kirby-cms-projects)

Ever wanted to experiment with your Kirby project on the fly, right from the command line? With Kirby Console, you can inspect and alter your project data instantly, no need to query the website!

### Installation

[](#installation)

The easiest way to get started is by installing Kirby Console globally with composer:

```
$ composer global require pstaender/kirby-console
```

### Usage

[](#usage)

Jump into your Kirby project folder and run:

```
$ kconsole
```

You’ll be greeted with something like:

```
Psy Shell v0.12.4 (PHP 8.2.22 — cli) by Justin Hileman
Kirby v4.1.0
>>>

```

Work with `kirby()`, `page()` and `site()` as you used to know:

```
>>> kirby()->version()
=> "4.1.0"
```

#### Impersonate

[](#impersonate)

Need to work as a specific user? Pass the user’s email as the first argument (handy for permission-restricted tasks like editing):

```
$ kconsole kirby
Psy Shell v0.12.4 (PHP 8.2.22 — cli) by Justin Hileman
Kirby v4.1.0 – kirby@getkirby.com
>>> kirby()->user()->email()
=> "kirby@getkirby.com"
```

### Kirby REPL Commands

[](#kirby-repl-commands)

#### r

[](#r)

Restart or Reload: The handy `r`-alias will use `restart` if available, a `reload` othewise:

```
>>> r
Exit:  Restarting...
```

#### restart

[](#restart)

Restart your Kirby instance after code or content changes with:

```
>>> restart
Exit:  Restarting...
Psy Shell v0.12.4 (PHP 8.2.22 — cli) by Justin Hileman
>>>
```

#### reload

[](#reload)

Refresh your Kirby instance after content changes with:

```
>>> reload
```

#### help

[](#help)

There are even more psysh build-in command, check out with:

```
>>> help
```

### Troubleshooting

[](#troubleshooting)

Can't get `kconsole` to start (can happen und not-bash-supporting-systems like windows etc)? Try `kirbyconsole` instead.

`kconsole` is a bash script wrapper to allow to restart the whole REPL. ([You can read here why I had to build that workaround](https://github.com/bobthecow/psysh/issues/416)).

### License

[](#license)

MIT

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance37

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~123 days

Recently: every ~245 days

Total

9

Last Release

622d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/bde394e0ccb15aff412f2a35b6e2172cf88c7baea4e5e643e741f71ec19df7cc?d=identicon)[pstaender](/maintainers/pstaender)

---

Top Contributors

[![pstaender](https://avatars.githubusercontent.com/u/140571?v=4)](https://github.com/pstaender "pstaender (18 commits)")

### Embed Badge

![Health badge](/badges/pstaender-kirby-console/health.svg)

```
[![Health](https://phpackages.com/badges/pstaender-kirby-console/health.svg)](https://phpackages.com/packages/pstaender-kirby-console)
```

###  Alternatives

[laravel/tinker

Powerful REPL for the Laravel framework.

7.4k423.8M1.8k](/packages/laravel-tinker)[drush/drush

Drush is a command line shell and scripting interface for Drupal, a veritable Swiss Army knife designed to make life easier for those of us who spend some of our working hours hacking away at the command prompt.

2.4k57.4M678](/packages/drush-drush)[codeception/codeception

All-in-one PHP Testing Framework

4.9k86.2M2.9k](/packages/codeception-codeception)[drupal/console

The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.

93615.1M157](/packages/drupal-console)[spatie/laravel-web-tinker

Artisan Tinker in your browser

1.2k3.8M6](/packages/spatie-laravel-web-tinker)[phalcon/devtools

This tools provide you useful scripts to generate code helping to develop faster and easy applications that use with Phalcon framework.

1.3k2.0M54](/packages/phalcon-devtools)

PHPackages © 2026

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