genxbe/k3x-cli-tools

与 Kirby CLI 一起使用的一组实用工具

维护者

详细信息

github.com/genxbe/k3x-cli-tools

主页

源代码

问题

安装: 4

依赖项: 0

建议者: 0

安全性: 0

星标: 6

关注者: 0

分支: 0

开放问题: 1

类型：kirby-plugin

0.0.4 2022-10-18 21:06 UTC

Requires

MIT 5e5eddb86ae1047d082486346c7a7eacdf1119d8

cliplugincommandlineterminalkirbykirby3kirby3-cmskirby3-plugingetkirbygenxbek3x-cli-tools

This package is auto-updated.

Last update: 2024-09-19 13:44:38 UTC

README

License PHP Version Kirby

ALPHA 版本，尚未经过实战测试！

与 Kirby CLI 一起使用的一组实用（且具有观点）工具。

选项

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

用法

您需要安装 kirby cli。您可以通过 composer 安装它。

composer global require getkirby/cli

此 CLI 插件包含一组具有观点的命令，旨在与 Kirby CLI 一起使用。

可用命令

Kirby 功能

  • kirby x:kirby:roots
    • 以美观的方式显示您的 Kirby 安装根目录
  • kirby x:kirby:down {email}
    • 将您的网站置于维护模式，并可选地提供电子邮件地址以供联系
  • kirby x:kirby:up
    • 禁用维护模式

插件功能

  • kirby x:plugins:list
    • 以美观的方式显示您的 Kirby 安装插件及其版本号
  • kirby x:plugins:delete
    • 从您的 Kirby 安装中删除插件（通过 'composer remove'）
  • kirby x:plugins:publish {filetype}
    • 将可覆盖的插件文件发布到您的根安装。如果您不传递文件类型，您将能够在方便的菜单中选择一个。

维护模式

如果您不想在根目录中有 .maintenance 文件时网站进入维护模式，则可以禁用维护模式。模式也可以通过 kirby x:kirby:down 和 kirby x:kirby:up （取消）激活。

即使在网站处于维护模式时，面板也始终可访问。如果您已登录，您还可以访问网站。

插件发布

您可以将可覆盖的插件文件发布到您的根安装。如果您想用自己的版本覆盖插件文件，这将很有用。您还可以使用此功能将插件文件发布到根安装，以便编辑。

此功能期望使用 blueprints、snippets、collections 和 templates 文件夹。这些主要文件夹内的子文件夹也受支持。

支持的文件类型

  • blueprints
  • snippets
  • collections
  • templates

安装

下载

下载并将此存储库复制到 /site/plugins/k3x-cli-tools。

Git 子模块

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

Composer

composer require genxbe/k3x-cli-tools

许可证

k3x-cli-tools 是一个开源软件，许可协议为 MIT 许可证。

致谢