README

A Hydro CLI 工具。

这是一个命令行工具，它通过允许从一开始就本地设置您的插件，从而取代了通过GitHub使用Filament的插件骨架的需求。

要求

• PHP 8.0+

安装

composer global require awcodes/hydro

升级

composer global update awcodes/hydro

使用

确保~/.composer/vendor/bin已添加到您的终端路径。

cd ~/<working-directory>
hydro new AwesomePlugin

自定义 Hydro

虽然 Hydro 提供的默认操作很棒，但大多数用户可能希望至少自定义几个步骤。幸运的是，Hydro 是为了自定义而构建的！

有三种方法可以自定义您对 Hydro 的使用：命令行参数或配置文件。

大多数用户可能希望设置一次首选配置选项，然后不再考虑。创建配置文件是解决这个问题的最佳方式。

但如果你发现自己需要根据项目逐个更改与 Hydro 的交互方式，你还可以在运行 Hydro 时使用命令行参数来自定义 Hydro。

创建配置文件

您可以在~/.hydro/config处创建配置文件，而不是每次创建新项目时都传递相同的参数。

以下命令创建文件（如果不存在），并编辑它

hydro edit-config

配置文件包含您可以自定义的配置参数，每次使用 Hydro 时都会读取。

使用命令行参数

传递的任何命令行参数都将覆盖 Hydro 的默认值和您的配置设置。请参阅传递的参数的完整列表。

Hydro 命令

• help 或 help-screen 显示帮助屏幕

• edit-config 编辑您的配置文件（如果不存在则创建一个）

  hydro edit-config

可配置参数

您可以在每次使用 Hydro 时选择性地传递一个或多个这些参数。如果您发现自己每次运行 Hydro 都想配置这些设置，那么这是使用 配置文件 的完美用途。

• -e 或 --editor 用于定义您的编辑器命令。在此处传递的内容将在创建项目后作为 $EDITOR . 运行。

  # runs "code ." in the project directory after creating the project
  hydro new AwesomePlugin --editor=code

• -p 或 --path 用于指定安装应用程序的位置。

  hydro new AwesomePlugin --path=~/Sites

• -m 或 --message 用于设置第一次 Git 提交消息。

  hydro new AwesomePlugin --message="This filament plugin runs fast!"

• -f 或 --force 用于强制安装，即使目录已存在

  # Creates a new scaffolding after deleting ~/Sites/awesome-plugin  
  hydro new AwesomePlugin --force

GitHub 仓库创建

重要：要创建新的仓库，Hydro 需要安装以下工具之一

• 官方的 GitHub 命令行工具
• 的 hub 命令行工具

如果未安装这两个工具，Hydro 将为您提供选项继续而不创建 GitHub 仓库。

• -g 或 --github 用于初始化新的私有 GitHub 仓库并将您的项目推送到它。

# Repository created at https://github.com/<your_github_username>/awesome-plugin
hydro new AwesomePlugin --github

• 使用 --gh-public 与 --github 将新 GitHub 仓库设置为公开。

hydro new AwesomePlugin --github --gh-public

• 使用 --gh-description 与 --github 初始化带有描述的新 GitHub 仓库。

hydro new AwesomePlugin --github --gh-description='My awesome Filament plugin'

• 使用 --gh-homepage 与 --github 初始化带有主页 URL 的新 GitHub 仓库。

hydro new AwesomePlugin --github --gh-homepage=https://example.com

• 使用--gh-org与--github初始化具有指定组织的GitHub仓库。

# Repository created at https://github.com/acme/awesome-plugin
hydro new AwesomePlugin --github --gh-org=acme