本参考资料列出了用于创建、配置、更新、部署、下载和删除主题的主题工具包命令。
通过命令行获取帮助
如果你想在工作时获得有关主题工具包命令的信息,可以通过运行以下命令获得帮助
获取所有命令和标志的列表
theme help
获取一条命令的所有标记列表
theme [command] --help
使用环境
所有主题工具包命令都可以在配置中选定的环境下运行。这样就可以在同一个配置文件中保存多个配置。
要使用环境,必须使用 –env 标志或简称 -e 指定环境名称。默认环境是开发环境。例如,如果要部署到生产环境,可以运行以下命令:
theme deploy --env=production
要部署到多个环境,可以通过额外的 –env 标志:
theme deploy --env=staging --env=production
Get
通过创建配置文件并下载所需的主题,在本地计算机上设置主题。
theme get –list 命令会返回指定商店中存在的主题和 ID 的列表:
theme get --list --password=[your-theme-kit-password] --store="[your-store.myshopify.com]"
获取主题 ID 后,可以运行以下命令。确保将 your-password 替换为主题密码,将 your-store 替换为店铺域名:
theme get --password=[your-theme-kit-password] --store="[your-store.myshopify.com]" --themeid=[your-theme-id]
运行主题获取命令会在当前目录下输出一个 config.yml 文件,内容如下:
development:
password: [your-theme-kit-password]
theme_id: "[your-theme-id]"
store: [your-store].myshopify.com
所需标志
简版 | 长版本 | 描述 |
---|---|---|
-p | --password | 用于将主题工具包连接到商店的主题密码 |
-s | --store | 商店的域名 |
-t | --themeid | 主题的 ID |
可选择的标志
标志 | 描述 |
---|---|
--live | 将主题ID设置为发布的主题 |
New
在指定的 Shopify 商店中创建新主题,使用主题密码和新主题 ID 初始化配置,并生成和上传默认模板,使主题有效。
theme new --password=[your-theme-kit-password] --store="[your-store.myshopify.com]" --name="Dramatic Theme"
所需标志
简版 | 长版本 | 描述 |
---|---|---|
-p | --password | 用于将主题工具包连接到商店的主题密码。 |
-s | --store | 商店的域名 |
-n | --name | 新主题的名称 |
可选择的标志
标志 | 描述 |
---|---|
--dir | 将主题ID设置为发布的主题 |
Configure
创建或更新配置文件。
theme configure --password=[your-theme-kit-password] --store="[your-store.myshopify.com]" --themeid=[your-theme-id]
运行主题 configure 命令会在当前目录下输出一个 config.yml 文件,内容如下:
development:
password: [your-theme-kit-password]
theme_id: "[your-theme-id]"
store: [your-store].myshopify.com
所需标志
简版 | 长版本 | 描述 |
---|---|---|
-p | --password | 用于将主题工具包连接到商店的主题密码。 |
-s | --store | 商店的域名 |
-n | --name | 新主题的名称 |
可选择的标志
标志 | 描述 |
---|---|
--live | 将主题ID设置为发布的主题 |
Open
在浏览器中打开主题的预览页面,并打印出 URL 以供参考。
theme open --env=production # opens http://your-store.myshopify.com?preview_theme_id=[your-theme-id]
可选择的标志
简版 | 长版本 | 描述 |
---|---|---|
-a | –allenvs | 打开配置文件中的每个环境。 |
- b | –browser | 指定打开 URL 的浏览器名称,与系统上的浏览器名称相匹配。 |
-E | –edit | 打开主题的网页编辑器 |
不适用的 | –hidepb | 打开预览页面时隐藏预览栏。 |
Watch
指示主题工具包观察对本地文件所做的任何更改,并自动将更新推送到连接的 Shopify 商店中的主题。更改和上传状态都会记录到终端。要关闭观察连接,请键入 ctrl + c。
可选择的标志
简版 | 长版本 | 描述 |
---|---|---|
-a | –allenvs | 观察配置文件中的每个环境。 |
- n | –notify | 文件路径或 URL。文件路径是您希望空闲时更新的文件。URL 路径是您希望发布网络钩子以报告文件更改的位置。 |
不适用的 | –allow-live | 允许主题工具包更改实时主题 |
使用带有 URL 的–notify
通过 URL 提供 –notify 标志将发送一个有效负载。例如,如果对 assets/app.js 文件进行了修改,URL 将收到一个 POST 请求,其有效载荷如下:
{
"files": ["assets/app.js"]
}
与其他工具集成
为帮助将 watch 与 LiveReload 等重载工具集成,你可以提供可选的 –notify 标志,并在工人闲置时提供你希望更新的文件路径。
例如,如果你让 LiveReload 监视/tmp/theme.update 文件的更新,那么你可以使用以下命令:
theme watch --notify=/tmp/theme.updatetheme watch --notify=/tmp/theme.update
Deploy
用当前项目目录中的主题替换已连接的 Shopify 商店中的主题。
theme deploy
如果在命令中提供文件名,则只会替换指定的文件。例如,如果只想部署 404.liquid 和 article.liquid 模板,可以使用以下命令:
theme deploy templates/404.liquid templates/article.liquid
如何工作
- 连接的 Shopify 商店中但不在本地磁盘上的任何文件都将从 Shopify 中删除。
- 同时存在于本地磁盘和已连接的 Shopify 商店中的任何文件都将被更新。
- 仅在本地磁盘上的文件将上传到已连接的 Shopify 商店。
主题工具包会计算每个文件的校验和值,只有当您在本地对资产进行了更改时,才会对其进行更新。
可选择的标志
简版 | 长版本 | 描述 |
---|---|---|
-a | –allenvs | 部署配置文件中的每个环境。 |
- n | –nodelete | 运行部署而不从 Shopify 中删除文件。 |
不适用的 | –allow-live | 如果您的主题当前已在连接的 Shopify 商店上线,则允许主题工具包部署文件更改。 |
Download
下载主题中的文件。
如果使用的下载命令不包含任何文件名,则会下载整个主题。如果在命令中提供某些文件名,则只下载指定的文件。
例如,如果只想下载 404.liquid 和 article.liquid 模板,可以使用以下命令:
theme download templates/404.liquid templates/article.liquid
与部署命令类似,主题工具包将跳过下载任何未更改的文件。
可选择的标志
标志 | 描述 |
---|---|
--live | 将主题ID设置为发布的主题 |
Remove
删除本地和连接的 Shopify 商店中的主题文件。
与其他文件操作命令不同,删除命令需要文件名。这样可以防止意外删除整个主题。
例如,如果您想删除 404.liquid 和 article.liquid 模板,可以使用以下命令:
theme remove templates/404.liquid templates/article.liquid
发表回复