Shopware CLI

Shopware CLI 是用于处理 Shopware 账户、项目及扩展相关常见工作的命令行工具。

目录

• 它能帮助解决什么
• 亮点
• 安装
• 使用方法
• 仓库结构
• 文档
• 贡献方式
• 许可证

它能帮助解决什么

使用此 CLI 可以创建并配置 Shopware 项目、管理 Shopware 账户、构建并验证扩展、自动化项目维护，或无需离开终端即可执行日常开发任务。

亮点

• 提供用于创建新 Shopware 项目或将现有项目迁移到本地开发环境中的安装、初始化及迁移向导
• 基于 Docker 的集成式本地开发环境，配有交互式终端用户界面（TUI）
• 从同一位置支持完整的日常开发流程：启动环境、运行监视器、查看日志、访问数据库及邮件工具
• 针对配置、缓存、管理后台、店面以及 CI 工作流提供的项目自动化命令
• 位于 shopware-cli account 下的与账户相关的命令
• 用于扩展构建、验证、格式化、编写变更日志及打包的辅助工具
• 适用于脚本和 CI 的非交互模式

安装

使用 Go 从源代码安装

go install github.com/shopware/shopware-cli@latest

从此仓库本地构建

git clone https://github.com/shopware/shopware-cli.git
cd shopware-cli
go build -o bin/shopware-cli .

使用方式

显示可用的命令：

shopware-cli --help

常用命令组：

shopware-cli account --help
shopware-cli extension --help
shopware-cli project --help

在不运行完整 CI 构建的情况下为项目生成 CycloneDX SBOM：

shopware-cli project sbom
shopware-cli project sbom ./my-shop --format cyclonedx-json --output sbom.json

如果需要适合 CI 的行为，请禁用提示：

shopware-cli --no-interaction <command>

仓库结构

• cmd/：用于账户、扩展及项目工作流的 Cobra 命令组
• internal/：用于 API、构建步骤、验证、TUI 以及实用工具的实现包
• .github/：自动化与工作流定义
• scripts/：仓库辅助脚本
• env-bridge/：环境桥接辅助程序的入口点

文档

• 官方文档：https://developer.shopware.com/docs/products/cli/

贡献

我们欢迎大家贡献代码。如果您想改进命令、文档或开发者工作流程，可以创建一个问题或提交拉取请求。

许可证

请参阅 LICENSE。