leafs/cli

一个简单的命令行工具,用于安装和与您的leaf应用程序交互

v2.13.0 2024-09-13 04:56 UTC

README




Leaf CLI 2

Latest Stable Version Total Downloads License



一个简单的命令行工具,用于创建和与您的leaf项目交互。您可以执行诸如安装包、与应用程序交互、预览应用程序等操作。

安装

您可以使用composer在您的系统上运行此工具

composer global require leafs/cli

请确保将Composer的全局供应商bin目录添加到您的$PATH中,以便系统可以定位leaf可执行文件。根据您的操作系统,此目录位于不同的位置;然而,一些常见位置包括

  • Windows: %USERPROFILE%\AppData\Roaming\Composer\vendor\bin
  • macOS: $HOME/.composer/vendor/bin
  • GNU / Linux发行版: $HOME/.config/composer/vendor/bin$HOME/.composer/vendor/bin

您也可以通过运行composer global about来找到Composer的全局安装路径。

例如(将composer bin添加到Linux路径)

export PATH=$PATH:$HOME/.config/composer/vendor/bin

例如(将composer bin添加到mac路径)

export PATH=$PATH:$HOME/.composer/vendor/bin
echo $PATH

使用指南

创建项目

要开始一个新项目,只需打开您的项目目录的终端或控制台,并输入

使用leaf 3

leaf create <project-name>

这会提示您选择一个预设

Creating a new Leaf app "<project-name>" in ./projects-directory.

* Please pick a preset 
  [0] leaf
  [1] leaf mvc
  [2] leaf api
 > 

选择一个数字将根据关联的预设生成leaf应用程序。如您所见,有3个预设

  • Leaf:一个裸露的leaf 3项目
  • Leaf MVC:一个带有leaf 3的leaf MVC项目
  • Leaf API:一个带有leaf 3的leaf API项目

您也可以直接选择预设,而无需通过交互式安装程序。

Leaf

leaf create <project-name> --basic

Leaf API

leaf create <project-name> --api

Leaf MVC

leaf create <project-name> --mvc

您还可以使用--custom添加一个完全可定制的leaf项目。

leaf create <project-name> --custom

安装包

此CLI工具还添加了从composer安装模块的功能

leaf install ui

这将安装leafs/ui包。

您还可以从Packagist安装第三方包

leaf install psr/log

交互式Shell

您还可以使用交互式Shell与您的应用程序交互。

$ leaf interact
...
>>> $user = new User;
...
>>> $user->name = "Mychi";
...
>>> $user->save();

预览应用程序

这将在PHP本地服务器上打开您的应用程序。

leaf serve

您还可以指定端口号

leaf serve -p 8000

在v2.1中,您还可以使用热模块监控启动leaf服务器。这将在您的应用程序代码有任何更改时重新加载您的应用程序。要开始,只需使用--watch标志启动leaf服务器。

leaf serve --port 8000 --watch

许可证

Leaf CLI是开源软件,许可协议为MIT许可证

😇 贡献

我们很高兴您能加入我们。所有贡献都受到欢迎!要开始,请熟悉我们的贡献指南,您就可以准备好提交您的第一个pull请求 🚀。

要报告安全漏洞,您可以通过@mychidarko@leafphp在twitter上联系我们。我们将协调修复,并最终将解决方案提交到该项目中。

代码贡献者

赞助Leaf

您的现金捐助对我们帮助Leaf变得更好起到了很大的作用。您可以在Open Collective上赞助Leaf和我们的任何包,或者查看捐助页面了解多种捐助方式。

对所有现有的现金/代码捐助者,我们都很爱你们 ❤️

现金捐助者

您可以在https://leafphp.dev/#sponsors查看所有赞助者。

🤯 链接/项目