Shopify CLI 是一款命令行界面工具,可帮助您创建 Shopify 应用程序和主题。它能快速生成 Shopify 应用程序、主题和自定义店面。您还可以使用它来自动化许多常见的开发任务。
本文档介绍如何使用 Shopify CLI 进行主题开发。
提示
您可以将Shopify CLI与Shopify GitHub集成,为您开发的主题添加版本控制。
在Shopify CLI和主题工具包之间做出选择
在大多数Shopify主题开发任务中,Shopify CLI取代了Theme Kit。如果您正在开发在线商店 2.0 主题,则应使用 Shopify CLI。只有在开发旧版主题时,才应使用 “主题工具包 “而非 “Shopify CLI”。
功能
Shopify CLI 通过以下功能加速您的主题开发过程:
- 使用开发主题安全地预览、测试和共享对主题的修改
- 预览主题时,热重载CSS和分区更改,或在文件更改时自动刷新页面
- 以 Dawn 为起点初始化新主题
- 从命令行推送和发布主题
- 使用环境处理多个主题
- 在主题上运行主题检查
开发主题
开发主题是连接到您用于开发的 Shopify 商店的临时隐藏主题。将主题作为开发主题连接到商店后,您就可以使用该商店的数据进行本地测试。
您可以使用 shopify theme dev 命令创建开发主题。
您可以在 Shopify 商店或开发商店中使用开发主题。开发主题不计入您的主题限制,并且在七天不活动后会从商店中删除。
当您运行 shopify auth 注销时,您的开发主题会被删除。如果您希望在注销后还能访问主题的预览链接,则应将开发主题推送到店铺中未发布的主题。
开发主题可用于执行以下任务:
- 实时查看本地开发主题的更改
- 使用 Shopify 管理主题编辑器自定义主题并与之互动
- 与其他开发者共享有密码保护的主题预览版
环境
许多命令配置,如与命令一起使用的主题和存储,都是通过 flags传递的。为了避免在每条命令中传递多个flags,并方便切换项目或上下文,可以使用环境。环境是命令配置的集合,可以使用单个 –environment flag按名称引用。
以下情况可能需要使用环境:
- 需要频繁切换开发商店。
- 使用主题访问密码访问多个存储空间。
- 需要将项目部署到主题的开发、暂存和生产实例中。
Installation
要了解如何在Windows、macOS或Linux上安装Shopify CLI,请参阅安装Shopify CLI。
入门
有关使用Shopify CLI创建或制作Shopify主题的详细信息,请参阅以下教程:
开始创建主题
学习如何设置主题开发环境并创建一个新主题。
定制现有主题
了解如何设置您的开发环境,在Shopify商店中创建主题。
命令参考
参考Shopify CLI主题命令参考,了解使用Shopify CLI创建主题的可用命令。
认证和访问商店
作为主题开发者,您可能希望使用 Shopify 商店来测试您的主题,或与利益相关者分享您的主题。您还可能需要在多个商店中工作,或者使用不同的密码来验证特定商店。了解使用 Shopify CLI 在店铺上工作时可以使用的认证方法,以及如何在账户和店铺之间切换。
身份验证
您可以使用以下验证方法,使用Shopify CLI对Shopify商店中的主题进行操作:
- 使用 Shopify 账户登录
- 提供主题访问密码
- 提供自定义应用程序访问令牌
使用 Shopify 帐户
您可以使用以下类型的 Shopify 账户访问您想要的商店
- 具有管理主题权限的协作者账户
- 具有主题权限的员工账户
- 店主账户
要使用 Shopify 账户进行身份验证,请运行一个需要店铺访问权限的命令。系统会提示您登录。
注意事项
要使用 Shopify CLI 开发商店或 Plus 沙盒商店,您必须是商店所有者,或在商店上拥有员工账户。当您第一次通过合作伙伴控制面板使用合作伙伴员工账户访问开发商店时,会自动创建员工账户。
在账户间切换
如果需要在不同账户间切换,请使用以下命令注销当前账户:
shopify auth logout
下次输入需要身份验证的命令时,系统会提示你登录,你可以输入一组新的凭证。
主题访问密码
您可以使用 “主题访问密码 “来验证您要访问的商店。主题访问密码是使用主题访问应用为商店生成的。
要使用主题访问密码,请在要针对商店运行的每条命令中加入–password标记。如果运行命令时不使用–password标记,Shopify CLI 会尝试使用您的 Shopify 账户凭据来运行命令。
自定义应用访问令牌
您可以使用自定义应用访问令牌来验证您要访问的商店。
要使用访问令牌进行身份验证,请在针对商店运行每条命令时传递–password标记。如果运行命令时不使用–password标记,Shopify CLI 会尝试使用您的 Shopify 账户凭据来运行命令。
您的自定义应用程序需要拥有 read_themes 和 write_themes API 访问权限。要启用热重载,您还需要为 Storefront API 集成添加 unauthenticated_read_content 访问权限,并将令牌作为环境变量传递,而不是使用 –password 标志。
连接到商店
第一次输入需要与 Shopify 商店交互的命令时,请在命令中加入–store 标志,并指定要与之交互的商店:
shopify theme dev --store my-store
在指定新的商店之前,你所指定的商店将用于以后的命令。
如果你想更改与之交互的商店,可在命令中加入–store 标志,指定要与之交互的新商店。
要查看正在使用的商店,请运行 shopify theme info:
shopify theme info
目录结构
只有当您使用的目录与默认的 Shopify 主题目录结构相匹配时,您才能运行某些主题命令,如 shopify theme dev。此结构代表未构建的主题,或已完成必要文件转换的主题。如果使用构建工具生成主题文件,则可能需要在生成文件所在的目录下运行命令。
默认的 Shopify 主题目录结构如下:
└── project
├── assets
├── config
├── layout
├── locales
├── sections
├── snippets
└── templates
└── customers
从Shopify CLI中排除文件
如果您不想使用Shopify CLI与主题库中的某县文件进行交互,您可以将它们添加到主题根目录下的.shopifyignore中。
.shopifyignore 接受以下格式的文件引用:
- 简单文件名: templates/product.temp.json
- 通配符:config/_secret.json、.jpg
- 正则表达式: /.(txt|gif|bat)$/
在push
或pull
过程中,还可以使用 –ignore 标志排除特定文件或模式。如果使用 .shopifyignore 排除文件,则 .shopifyignore 和 –ignore标志的内容都将生效。
使用 Shopify CLI 进行持续集成
如果您有一个主题需要编程处理,那么您可以将 Shopify CLI 集成到您的 CI/CD 管道中,以执行推送、拉动和发布主题等操作。
升级Shopify CLI
要将 Shopify CLI 3.x 升级到最新版本,请使用升级命令:
shopify upgrade
要检查 CLI 版本,请使用版本命令
shopify version
原文:https://shopify.dev/docs/themes/tools/cli#getting-started
发表回复