osmose/pulser-cli

Pulser WordPress 主题的 CLI 工具

dev-main 2024-05-23 15:59 UTC

This package is auto-updated.

Last update: 2024-09-23 16:47:05 UTC


README

描述

Pulser CLI 是一个命令行界面,旨在帮助 Osmose 网站开发人员为 Pulser WordPress 主题创建和管理高级自定义字段 (ACF) 块。它便于连接到私有仓库,允许团队成员高效地将预构建的块导入到他们的项目中。

功能

  • 认证:安全地连接到 Pulser 块仓库。
  • 检查认证:验证当前的认证状态。
  • 创建块:构建新的 ACF 块。
  • 导入块:从仓库中导入现有的块到本地项目。

要求

  • PHP ^8.0
  • Symfony Console ^6.0|^7.0
  • Symfony HttpClient ^6.0|^7.0

安装

要安装 Pulser CLI,运行以下命令

composer global require osmose/pulser-cli

配置

通过设置必要的 API 令牌和其他连接到 Pulser 仓库所需的偏好设置来配置 Pulser CLI。

API 令牌设置

为了与 Pulser 仓库进行认证,开发者需要配置他们的 API 令牌。通过访问 pulser.osmose.net 并导航到个人资料部分来生成您的个人令牌。确保您在这个平台上有一个账户。一旦您有了令牌,使用以下命令来设置它

pulser auth:token <your-token>

用您生成的实际令牌替换 <your-token>。这一步对于访问 Pulser 块仓库并使用 CLI 的功能至关重要。

使用方法

安装后,根据您的需要使用以下命令

  • 认证pulser authenticate
  • 检查认证pulser auth-check
  • 创建块pulser create-block
  • 导入块pulser import-block

许可证

本项目是专有软件。未经明确许可,禁止未经授权的复制、修改、分发或使用。

贡献

如果您是 Osmose 开发团队的一员,并希望为 Pulser CLI 的开发做出贡献,请遵循标准的拉取请求流程,并遵守 Osmose 设置的编码标准。

支持

如需支持,请联系 Osmose 技术支持团队或参考内部 Osmose 开发者文档。

本 README 提供了全面指南,帮助开发人员开始使用 Pulser CLI 工具,并有效地使用其功能进行 WordPress 开发。