模板CLI选项和命令

本文是BigCommerce强大的主题开发和部署工具Stencil CLI的综合命令参考。有关操作系统的安装说明，请参见模板安装CLI。有关BigCommerce的模板主题引擎的更多信息，请参见关于模板。继续阅读下面关于每个Stencil CLI命令和选项的详细信息。

命令概述

使用模板命令行的语法如下:

钢网<年代pan class="token operator"><命令<年代pan class="token operator">>(<选项<年代pan class="token operator">>]<参数<年代pan class="token operator">>

运行模板帮助输出命令及其描述的完整列表。如需更多详细信息和使用示例，请点击下表中的链接:

命令	描述
初始化	交互式地创建一个.stencil文件或secrets.stencil.json和config.stencil.json文件(如果使用Stencil V3.1版本或更高版本)，它配置如何在本地运行BigCommerce商店。
开始	使用当前目录中的主题文件和来自实时存储的数据启动BigCommerce店面本地开发环境。
包	将主题打包成结构化的. zip文件，可以上传到BigCommerce。
拉	从活动存储上的活动主题提取配置并更新本地配置。
下载	从活动主题下载主题文件，如果需要，覆盖本地文件。
推	将主题绑定到. zip文件;然后直接上传. zipBigCommerce。
释放	在主题的GitHub库中创建一个新版本。
帮助	显示帮助并返回可用于指定命令的所有选项。

模板帮助

显示帮助并返回指定命令的所有可用选项。

用法:

钢网<年代pan class="token function">帮助(<命令<年代pan class="token operator">>]

例子:

~ $模板<年代pan class="token function">帮助用法:模板<年代pan class="token punctuation">(选项<年代pan class="token punctuation">](命令<年代pan class="token punctuation">]选项:-V，——version输出版本号。-h，——help输出使用信息<年代pan class="token punctuation">。。。

模板初始化

创建一个.stencil文件或secrets.stencil.json和config.stencil.json(如果使用Stencil V3.1版本或更高版本)用于配置实时预览钢网开始运行。您可以使用可选的交换机指定配置信息;如果您没有通过选项指定配置信息，Stencil CLI将提示您这样做。

注意:对于自定义模板，只使用config.stencil.json文件。的config.stencil.json文件包含与主题相关的配置信息，如存储URL、自定义模板等。的secrets.stencil.json文件包含访问令牌。

用法:

模板初始化<年代pan class="token punctuation">(url——<年代pan class="token operator"><STORE_URL<年代pan class="token operator">>](——令牌<年代pan class="token operator"><API_TOKEN<年代pan class="token operator">>]

选项	别名	描述
——港口(< HTTP_PORT >)	- p	的HTTP提供现场主题预览时使用的端口号。
——令牌(< API_TOKEN >)	- t	的BigCommerce API令牌。
——url (< STORE_URL >)	- u	BigCommerce店面URL。

钢网开始

使用当前目录中的主题文件启动实时主题预览。

用法:

钢网开始<年代pan class="token punctuation">(- v<年代pan class="token operator">|——版本<年代pan class="token punctuation">](- o<年代pan class="token operator">|——打开<年代pan class="token punctuation">](- v<年代pan class="token operator">|——变化<年代pan class="token punctuation">](- t<年代pan class="token operator">|——测试<年代pan class="token punctuation">](- t<年代pan class="token operator">|——隧道<年代pan class="token punctuation">]钢网开始<年代pan class="token punctuation">(- h<年代pan class="token operator">|——帮助<年代pan class="token punctuation">]

例子:

模板开始开放<年代pan class="token comment">#在默认浏览器中打开实时主题预览

选项	别名	描述
——版本	- v	输出版本号
——打开	- o	自动打开默认浏览器
——变异(<名称>)	- v	设置在发展中使用的主题变体
——测试	- t	启用QA模式，将所有javascript捆绑在一起进行本地测试
——隧道		创建一个隧道URL，它指向任何人都可以使用的本地服务器
——no - cache	- n	关闭API资源数据的缓存(缓存每5分钟刷新一次)
——帮助	- h	输出使用信息

模板包

将主题打包成结构化的. zip文件，可以上传到BigCommerce。

用法:

模板包

模板拉

从活动存储上的活动主题提取配置并更新本地配置。这是有用的，如果任何主题设置已经更改在Page Builder，因为它将防止您覆盖他们与你的下一个主题上载首先同步他们。

用法:

用法:模板拉<年代pan class="token punctuation">(<选项<年代pan class="token operator">>]

选项	别名	描述
——主机(主机名)	- h	指定API主机(默认:api.bigcommerce.com)
——文件名(<文件名>)	- f	指定要用于合并配置的文件名(默认值:json)
——保存	- s	下载最近保存的配置，而不是当前的配置。
——channel_id [< channel_id >)	-c	如果商店有多个店面，则指定店面的通道ID。
——帮助	- h	输出使用信息

例子:

模板拉

钢网推

将主题打包成结构化的. zip文件;然后直接上传(推送). zipBigCommerce。

用法:

用法:模板推<年代pan class="token punctuation">(<选项<年代pan class="token operator">>]

选项	别名	描述
——版本	- v	输出版本号
——主机(主机名)		指定API主机(默认:api.bigcommerce.com)
——文件(<文件名>)	- f	指定要上传的包的文件名
——保存(<文件名)	年代	指定保存包的文件名
——激活(< VARIATIONNAME >)	——一个	跳过激活提示;指定变异或留空以选择第一个变异
——删除	- d	如果达到上传限制，删除最早的私有，非活动的主题
——帮助	- h	输出使用信息

例子:

模板推-f基石2.3.2.zip<年代pan class="token comment">#上传指定的文件，如果文件已经存在，则跳过捆绑

模板下载

从活动存储中下载主题文件，覆盖本地目录中的文件。

用法:

用法:模板下载<年代pan class="token punctuation">(<选项<年代pan class="token operator">>]

选项	别名	描述
——主机(主机名)	- h	指定API主机(默认:api.bigcommerce.com)
——文件(<文件名>)	- f	指定要从主题下载的单个文件，例如。模板/布局/ base.html
——排除	- e	指定要从下载中排除的目录。
——channel_id [< channel_id >)	-c	如果商店有多个店面，则指定店面的通道ID。
——帮助	- h	输出使用信息

例子:

模板下载-f package.json

钢网发布

在主题的GitHub库中创建一个新版本。BigCommerce之外的开发者可以将其用于Stencil的基石基础主题的分支(而不是master)，或者用于他们自己独立于基石的并行主题。

用法:

钢网发布<年代pan class="token punctuation">(<选项<年代pan class="token operator">>]

选项	别名	描述
——版本	- v	输出版本号
——帮助	- h	输出使用信息

资源

相关文章

• CLI授权和初始化
• 故障排除您的设置