PHPackages                             genxbe/k3x-cli-tools - 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. genxbe/k3x-cli-tools

ActiveKirby-plugin[CLI & Console](/categories/cli)

genxbe/k3x-cli-tools
====================

A bunch of usefull tools to use with the Kirby CLI

0.0.4(3y ago)55[1 issues](https://github.com/genxbe/k3x-cli-tools/issues)MITPHPPHP ^8.0

Since Oct 18Pushed 3y agoCompare

[ Source](https://github.com/genxbe/k3x-cli-tools)[ Packagist](https://packagist.org/packages/genxbe/k3x-cli-tools)[ Docs](https://github.com/genxbe/k3x-cli-tools)[ RSS](/packages/genxbe-k3x-cli-tools/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (4)Versions (6)Used By (0)

Kirby CLI tools
===============

[](#kirby-cli-tools)

[![License](https://camo.githubusercontent.com/784362b26e4b3546254f1893e778ba64616e362bd6ac791991d2c9e880a3a64e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e2e737667)](https://camo.githubusercontent.com/784362b26e4b3546254f1893e778ba64616e362bd6ac791991d2c9e880a3a64e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e2e737667) [![PHP Version](https://camo.githubusercontent.com/6ca8065db628c875a65bde2e54e00b1d5e21d5d84c0ac683d8e103e8be33388d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f67656e7862652f6b33782d636c692d746f6f6c732f706870)](https://camo.githubusercontent.com/6ca8065db628c875a65bde2e54e00b1d5e21d5d84c0ac683d8e103e8be33388d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f67656e7862652f6b33782d636c692d746f6f6c732f706870) [![Kirby](https://camo.githubusercontent.com/3b51d80ee85c9ae2c104d2f0a100ac7475a5b851fdc0876605aaad1899c9b0d8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4b697262792d332e382b2d396133656366382e737667)](https://camo.githubusercontent.com/3b51d80ee85c9ae2c104d2f0a100ac7475a5b851fdc0876605aaad1899c9b0d8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4b697262792d332e382b2d396133656366382e737667)

**ALPHA VERSION, not battle tested yet!**

A bunch of usefull (and opiniated) tools to use with the Kirby CLI.

Options
-------

[](#options)

```
# site/config/config.php
return [
    'genxbe.k3x-cli-tools' => [
        'maintenance' => true,
    ],
];
```

Usage
-----

[](#usage)

You need to have the kirby cli installed. You can install it via composer:

```
composer global require getkirby/cli
```

This CLI plugin has a set of opinionated commands that are meant to be used with the Kirby CLI.

### Available commands

[](#available-commands)

#### Kirby features

[](#kirby-features)

- `kirby x:kirby:roots`
    - Show the roots of your Kirby installation in a pretty way
- `kirby x:kirby:down {email}`
    - Put your site in maintenance mode with an optional email address for contact reasons
- `kirby x:kirby:up`
    - Disable the maintenance mode

#### Plugin features

[](#plugin-features)

- `kirby x:plugins:list`
    - Show the plugins of your kirby installation with version numbers in a pretty way
- `kirby x:plugins:delete`
    - Delete a plugin from your kirby installation (via 'composer remove')
- `kirby x:plugins:publish {filetype}`
    - Publish plugin overwriteable files to your root installation. If you don't pass a filetype you will be asked to choose one in a handy menu.

### Maintenance mode

[](#maintenance-mode)

You can disable maintenance mode if you don't want your site to go in maintenance mode when there's a `.maintenance` file in the root. Mode can also be (de)activated via `kirby x:kirby:down` and `kirby x:kirby:up`.

The panel will always be reachable, even if the site is in maintenance mode. If you are logged in you will also be able to visit the site.

### Plugin publishing

[](#plugin-publishing)

You can publish plugin overwriteable files to your root installation. This is useful if you want to overwrite a plugin file with your own version. You can also use this to publish a plugin file to your root installation if you want to edit it.

This feature expects usage of the folders `blueprints`, `snippets`, `collections` and `templates`. Subfolders within these main folders are also supported.

Filetypes supported:

- blueprints
- snippets
- collections
- templates

Installation
------------

[](#installation)

### Download

[](#download)

Download and copy this repository to `/site/plugins/k3x-cli-tools`.

### Git submodule

[](#git-submodule)

```
git submodule add https://github.com/genxbe/k3x-cli-tools.git site/plugins/k3x-cli-tools

```

### Composer

[](#composer)

```
composer require genxbe/k3x-cli-tools

```

License
-------

[](#license)

k3x-cli-tools is an open-sourced software licensed under the [MIT license](LICENSE.md).

Credits
-------

[](#credits)

- [Sam Serrien](https://twitter.com/samzzi) @ [GeNx](https://genx.be)

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity45

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

Total

4

Last Release

1307d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/32242279?v=4)[Sam Serrien](/maintainers/samzzi)[@samzzi](https://github.com/samzzi)

---

Top Contributors

[![samzzi](https://avatars.githubusercontent.com/u/32242279?v=4)](https://github.com/samzzi "samzzi (7 commits)")

---

Tags

clicmscommandlinegetkirbykirbyphppluginterminalplugincliterminalkirbycommandlinekirby3kirby3-pluginkirby3-cmsgetkirbygenxbek3x-cli-tools

### Embed Badge

![Health badge](/badges/genxbe-k3x-cli-tools/health.svg)

```
[![Health](https://phpackages.com/badges/genxbe-k3x-cli-tools/health.svg)](https://phpackages.com/packages/genxbe-k3x-cli-tools)
```

###  Alternatives

[fabianmichael/kirby-meta

Your all-in-one powerhouse for any SEO and metadata needs imaginable.

6910.7k1](/packages/fabianmichael-kirby-meta)[php-school/php-workshop

PHP Workshop Framework

466.3k6](/packages/php-school-php-workshop)[genxbe/kirby-ray

Helper tool that enables ray on all the extendable methods.

232.2k](/packages/genxbe-kirby-ray)

PHPackages © 2026

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