用于主题的Shopify CLI命令

本文列出了用于创建主题相关的Shopify CLI 的命令。

本组命令使用的语法是 shopify [topic] [command]。

命令概述

init

克隆一个 Git 仓库到本地计算机，作为构建主题的起点。

如果未指定 Git 仓库，则此命令会在当前文件夹中创建 Shopify 示例主题 Dawn 的副本，并指定名称。如果没有提供名称，系统会提示您输入一个名称。

shopify theme init [name]

init flags

dev

将当前主题作为指定主题或开发主题上传到商店，以便预览。

此命令会返回以下信息：

• 指向开发主题的链接 http://127.0.0.1:9292。该 URL 可以热重载 CSS 和分区的本地更改，或在文件更改时刷新整个页面，让你可以使用商店的数据实时预览更改。你可以使用 –host 和 –port 指定不同的网络接口和端口。
• Shopify 管理中的主题编辑器链接。
• 可与其他开发者分享的预览链接。

如果您在当前环境下已经有一个开发主题，那么这条命令会用您的本地主题替换开发主题。您可以使用 –theme-editor-sync 标记覆盖此功能。

运行 shopify auth logout时，开发主题会被删除。如果您需要一个注销后仍可使用的预览链接，则应分享您的主题或推送未发布的主题到您商店中。

您只能在符合 Shopify 默认主题文件夹结构的目录下运行此命令。

shopify theme dev

dev flags

check

调用并运行主题检查，分析主题代码中的错误，确保遵循主题和 Liquid 最佳实践。

shopify theme check

check flags

list

列出商店中的主题及其 ID 和状态。

shopify theme list

list flags

open

返回可以预览指定主题的链接。会返回以下链接：

• 指向 Shopify 管理器中主题编辑器的链接。
• 可与其他开发者分享的预览链接。

如果您没有指定主题，系统会提示您从商店主题列表中选择要打开的主题。

shopify theme open

open flags

pull

从 Shopify 获取主题文件。
如果没有指定主题，系统会提示您从商店主题列表中选择要提取的主题。

shopify theme pull

pull flags

push

将本地主题文件上传到 Shopify，覆盖指定的远程版本。

如果没有指定主题，系统会提示您从商店主题列表中选择要覆盖的主题。

只能在与默认 Shopify 主题文件夹结构相匹配的目录中运行此命令。

此命令会返回以下信息：

• 指向 Shopify 管理器中主题编辑器的链接。
• 可与他人分享的预览链接。

shopify theme push

如果使用 –json 标志，则主题信息将以 JSON 格式返回，可用作脚本或持续集成的机器可读输入。

shopify theme push --unpublished --json

样例输出

{
  "theme": {
    "id": 108267175958,
    "name": "MyTheme",
    "role": "unpublished",
    "shop": "mystore.myshopify.com",
    "editor_url": "https://mystore.myshopify.com/admin/themes/108267175958/editor",
    "preview_url": "https://mystore.myshopify.com/?preview_theme_id=108267175958"
  }
}

push flags

share

将主题作为一个新的、未发布的主题上传到主题库中。主题会被随机命名。
此命令会返回一个预览链接，你可以与他人分享。

shopify theme share

share flags

publish

从主题库中发布一个未发布的主题。

如果没有指定主题 ID，系统会提示您从商店主题列表中选择要发布的主题。

您只能在符合 Shopify 默认主题文件夹结构的目录下运行此命令。

如果您想发布本地主题，则需要先运行 shopify theme push。系统会要求您确认是否要发布指定的主题。您可以使用 –force（强制）标志跳过此确认。

shopify theme publish

publish flags

package

将本地主题文件打包成 ZIP 文件，并上传到 Shopify。软件包中只包含符合默认 Shopify 主题文件夹结构的文件夹。根据settings_schema.json 文件中的参数，ZIP 文件使用 theme_name-theme_version.zip 名称。

shopify theme package

package flags

delete

从商店中删除一个主题。

您可以通过 ID 指定多个主题。如果没有指定主题，系统会提示您从商店的主题列表中选择要删除的主题。

在删除指定的主题之前，系统会要求您确认是否要删除这些主题。你可以使用 –force 标记跳过确认。

shopify theme delete

delete flags

language-server

启动语言服务器协议服务器

shopify theme language-server

language-server flags

console

启动 Shopify Liquid REPL（读取-评估-打印循环）工具。该工具提供一个交互式终端界面，用于评估 Liquid 片段，并使用真实商店数据检查 Liquid 对象、过滤器和标签。

要启动该工具，请使用以下命令：

shopify theme console

您还可以使用 URL 向控制台提供情况，因为某些 Liquid 对象是特定情况的。例如

shopify theme console --url /products/classic-leather-jacket

console flags

info

显示有关主题环境的信息，包括当前商店的信息。

shopify theme info

info flags

logout

退出 Shopify 账户或合作伙伴账户

shopify auth logout

config autocorrect

启用或禁用命令自动更正。默认情况下，自动更正处于关闭状态。

shopify config autocorrect COMMAND

启用自动更正功能后，Shopify CLI 会自动运行更正版本的命令。
禁用自动更正功能时，您需要确认是否要对输入错误的命令进行更正。

help

列出可用命令并说明其作用

shopify help

您可以为任何命令添加帮助标志，以了解更多相关信息。使用 –help 或 -h

shopify dev --help

version

显示您正在运行的 Shopify CLI 版本

shopify version

upgrade

将 @shopify/cli 和 @shopify/theme 软件包升级到最新版本。

shopify upgrade

brew upgrade && brew update

search

在 Shopify.dev 上开始搜索

# open the search modal on Shopify.dev
npm run shopify search

# search for a term on Shopify.dev
npm run shopify search <query>

# search for a phrase on Shopify.dev
npm run shopify search "<a search query separated by spaces>"

# open the search modal on Shopify.dev
yarn shopify search

# search for a term on Shopify.dev
yarn shopify search <query>

# search for a phrase on Shopify.dev
yarn shopify search "<a search query separated by spaces>"

# open the search modal on Shopify.dev
pnpm shopify search

# search for a term on Shopify.dev
pnpm shopify search <query>

# search for a phrase on Shopify.dev
pnpm shopify search "<a search query separated by spaces>"

搜索 Shopify.dev 文档时，可选择向命令传递一个查询参数。