{"_id":"5620174c5624f5190004caa2","parentDoc":null,"user":"55a6caa022cfa321008e01d6","__v":24,"version":{"_id":"55a6e72f8cc73e0d00096638","project":"55a6e72e8cc73e0d00096635","hasReference":false,"__v":29,"hasDoc":true,"createdAt":"2015-07-15T23:05:19.125Z","releaseDate":"2015-07-15T23:05:19.125Z","categories":["55a6e7308cc73e0d00096639","55b7ed07aea7c8190058badb","5604567c0c78b00d0039b191","5605e6f23a93940d002b3e4a","5605f2bba4574a0d00811365","5605f309a4574a0d00811366","5608e3b98aedf50d0004cf8f","5608e4318aedf50d0004cf90","5608e6b5a7cc2f0d00d9754d","5608e6d331beb60d001b6560","5608f879a7cc2f0d00d97580","560b097887b71d0d000d3bd9","560b13cbafa0990d00979545","560b5cbec341310d00de2a01","560b5cd0c341310d00de2a02","566a35b81e08750d00a0c49b","566a3e8503b4b20d00d02a4a","567889d307bf6a0d0083edc8","569c8b7c15bb390d00db6f9d","56b254dc65ddf50d0076ba8f","57a8ebc4cdeea20e001d2a63","57e48a4000c8680e00fae6e7","5808216773557d0f00a1e428","58105ad54a8aa50f00aa4cba","58105bf298aea40f00afa3ba","58105f548a4aed0f00d67536","581061b898aea40f00afa3be","584b3de7e5f3a42300df6ef7","596839a75965d400155bb750"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5605f2bba4574a0d00811365","__v":26,"pages":["5608e4d6c5cff70d007d00d5","5608e4e7c5cff70d007d00d8","5608e4fbc5cff70d007d00da","5608e5096d8c440d000c79f3","5608e5156d8c440d000c79f6","5608e52331beb60d001b6558","5608e8248aedf50d0004cf98","5608e87e8aedf50d0004cf9b","5609bf4f9f85a70d00908530","562822dd5cfea90d00ddc5d7","562831c40653060d00a2f750","563d2732260dde0d00c5eab1","5660d2bee163310d006b19c1","567bb35b93919f0d00c97b1c","567bba643241c20d00b730de","567bbc14b56bac0d0019d933","567bc0473241c20d00b730e5","568b6bd8fe6fcc0d006dc8f7","56a427125fb2530d00421b67","56a42a5194ec0a0d00b3a012","56a42aaa545bc50d000e3ada","56ddff97bea78e20003a778f","56de00ab26744429006648ba","56de12a33168720e00c11b02","56e37f388b32a10e00f79755","56e73362e622c90e00dc55b3"],"project":"55a6e72e8cc73e0d00096635","version":"55a6e72f8cc73e0d00096638","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-26T01:19:55.795Z","from_sync":false,"order":2,"slug":"installation-and-launch","title":"Installation and Launch"},"project":"55a6e72e8cc73e0d00096635","updates":["56f56311b9131917003ca85c"],"next":{"pages":[],"description":""},"createdAt":"2015-10-15T21:14:52.168Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":19,"body":"This page covers:\n* [Basic Commands/Options](#basicopt)\n* [Startup Options](#startopt)\n* [Push Options](#pushopt)\n[block:html]\n{\n  \"html\": \"<H2> <a name=\\\"basicopt\\\"></a> Basic Commands/Options </h2>\\n\\nTo see the basic commands and options that the Stencil CLI package supports, enter any of the following on your command line:<br>\\n\\n<p></p><pre>\\nstencil\\nstencil help\\nstencil --help\\nstencil -h\\n</pre>\\n\\n(Stencil CLI's general syntax is: <span class=\\\"inline-code\\\">stencil [options] &lt;commands&gt; [parameters]</span>.)<br>\\n\\n<p></p>Your terminal window will display currently supported commands and options, as follows:\\n\\n<p></p>\\n<table>\\n  <tr>\\n    <th>Command</th>\\n    <th>Description</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">init</td>\\n    <td class=\\\"\\\">Interactively creates a <span class=\\\"inline-code\\\">.stencil</span> file, which configures how to run a BigCommerce store locally.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><A NAME=\\\"startcmd\\\"></a>start</td>\\n    <td class=\\\"\\\">Starts up the BigCommerce store, using theme files in the current directory. \\n      <br><p></p>\\n<b>Note:</b> If <span class=\\\"inline-code\\\">stencil start</span> generates an <span class=\\\"inline-code\\\">Unauthorized, please use a valid username/token</span> error: Please make sure that the <span class=\\\"inline-code\\\">.stencil</span> file contains the correct store URL (and, for OAuth, correct <NOBR><a href=\\\"/docs/initializing-stencil#https\\\">URL prefix</a></nobr>). Also, verify that you have copied the correct credentials, as outlined <a href=\\\"/docs/copying-a-token-to-initialize-stencil\\\">here</a>. If you continue to get the same error, please reissue tokens, as outlined <a href=\\\"/docs/issuing-and-reissuing-tokens\\\">here</a>.\\n    </td>\\n  </tr>\\n  \\n <!-- <tr>\\n    <td class=\\\"\\\" colspan=\\\"2\\\"><div class=\\\"block-edit-callout type-{{'warning'}}<span class=\\\"indent2\\\">(<b>Note:</b> If <span class=\\\"inline-code\\\">stencil start</span> generates an <span class=\\\"inline-code\\\">Unauthorized, please use a valid username/token</span> error, please see troubleshooting instructions <a href=\\\"/docs/running-stencil-locally#TokenErrors\\\">here</a>.)</span></div></td>\\n<td class=\\\"\\\"></td>\\n  </tr> -->\\n  \\n  <tr>\\n    <td class=\\\"\\\"><A NAME=\\\"bundlecmd\\\"></a>bundle</td>\\n    <td class=\\\"\\\">Bundles up the theme into a structured .zip file, which can be uploaded to BigCommerce. <NOBR>(Please see restrictions</nobr> <a href=\\\"/docs/uploading-a-custom-theme#restrix\\\">here</a>.)</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\"><A NAME=\\\"pushcmd\\\"></a>push</td>\\n    <td class=\\\"\\\">Bundles up the theme into a structured .zip file; then directly uploads (pushes) the .zip to BigCommerce. <NOBR><NOBR>(Please see</nobr> usage instructions <a href=\\\"/docs/bundling-submitting#push\\\">here</a>. The same <a href=\\\"/docs/uploading-a-custom-theme#restrix\\\">restrictions</a> apply as for the <span class=\\\"inline-code\\\">bundle</span> command.)</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">help &lt;cmd&gt;</td>\\n    <td class=\\\"\\\">Displays help for the specified &lt;cmd&gt;.</td>\\n  </tr>  \\n</table>\\n\\n\\n<table>\\n  <tr>\\n    <th>Option</th>\\n    <th>Description</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">-h, --help</td>\\n    <td class=\\\"\\\">Outputs usage information.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">-V, --version</td>\\n    <td class=\\\"\\\">Outputs the version number (which is read from <span class=\\\"inline-code\\\">&lt;theme-name&gt;/package.json</span>).</td>\\n  </tr>\\n</table>\\n\\n\\n<H2> <a name=\\\"startopt\\\"></a> Startup Options </h2>\\n\\nTo see Stencil CLI's additional options for the <span class=\\\"inline-code\\\">stencil start</span> command (described <a href=\\\"#startcmd\\\">above</a>), enter <!--any of--> the following on your command line:<br>\\n\\n<p></p><pre>\\nstencil help start <!--\\nstencil -h start -->\\n</pre>\\n\\n<p></p>Your terminal window will display currently supported options, as follows:\\n\\n<p></p>\\n<table>\\n  <tr>\\n    <th>Option</th>\\n    <th>Description</th>\\n  <tr>\\n    <td class=\\\"\\\">-e</td>\\n    <td class=\\\"\\\">Also starts Theme Editor, as a parallel server, on its default port: <a href=\\\"http://localhost:8181\\\">http://localhost:8181</a>.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><NOBR>-e --theme-editor-port &lt;port-number&gt;</nobr></td>\\n    <td class=\\\"\\\">Also starts Theme Editor, as a parallel server, on the specified <NOBR>&lt;port-number&gt;</nobr>. (<NOBR>The &lt;port-number&gt;</nobr> parameter can be between 1024 and 65535.)</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\" colspan=\\\"2\\\"><div class=\\\"block-edit-callout type-warning\\\">(<b>Note:</b> Theme Editor's initial release has been tested only on the Chrome browser.)</span></div></td>\\n    <!-- <td class=\\\"\\\"></td> -->\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\"><NOBR>-n, --no-cache</nobr></td>\\n    <td class=\\\"\\\">Disables caching of API resource data per storefront page. (<NOBR>To re-enable</nobr> caching, restart Stencil without these options.)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><NOBR>-o, --open</nobr></td>\\n    <td class=\\\"\\\">Automatically opens the default browser.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><NOBR>-t, --test</nobr></td>\\n    <td class=\\\"\\\">Enables QA mode, which bundles all JavaScript to accelerate local testing.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">--tunnel</td>\\n    <td class=\\\"\\\">Creates a tunnel URL, pointing to your local server, that anyone can use.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><NOBR>-v &lt;name&gt;,</nobr> <NOBR>--variation &lt;name&gt;</nobr></td>\\n    <td class=\\\"\\\">Selects a theme variation to use while developing.</td>\\n  </tr>\\n</table>\"\n}\n[/block]\n## <a name=\"pushopt\"></a> Push Options\n\nTo see Stencil CLI's additional options for the `stencil push` command (described [above](#pushcmd\")), enter the following on your command line:\n\n```\nstencil help push\n```\n\nYour terminal window will display supported options, notably including:\n[block:html]\n{\n  \"html\": \"<table>\\n  <tr>\\n    <th>Option</th>\\n    <th>Description</th>\\n  <tr>\\n    <td class=\\\"\\\">-f &lt;filename&gt;, --file &lt;filename&gt;</td>\\n    <td class=\\\"\\\">Specifies the filename of a bundle to upload.\\n</td>\\n  </tr>\\n</table>\"\n}\n[/block]\nYou can use this option in cases where you have already run either `stencil push` or `stencil bundle` to [bundle your theme](/docs/bundling-submitting#ship-zip-small), but the resulting .zip file has not yet uploaded to BigCommerce. Use the `filename` parameter to identify the .generated .zip file in your theme directory.\n\nWhen you run `stencil push` with this option, Stencil CLI will skip all its bundling steps and diagnostics. It will proceed directly to [uploading the specified file](/docs/bundling-submitting#bundled), displaying its `Processing` progress bar to show upload status.","excerpt":"","slug":"stencil-cli-options","type":"basic","title":"Stencil CLI Options"}

Stencil CLI Options


This page covers: * [Basic Commands/Options](#basicopt) * [Startup Options](#startopt) * [Push Options](#pushopt) [block:html] { "html": "<H2> <a name=\"basicopt\"></a> Basic Commands/Options </h2>\n\nTo see the basic commands and options that the Stencil CLI package supports, enter any of the following on your command line:<br>\n\n<p></p><pre>\nstencil\nstencil help\nstencil --help\nstencil -h\n</pre>\n\n(Stencil CLI's general syntax is: <span class=\"inline-code\">stencil [options] &lt;commands&gt; [parameters]</span>.)<br>\n\n<p></p>Your terminal window will display currently supported commands and options, as follows:\n\n<p></p>\n<table>\n <tr>\n <th>Command</th>\n <th>Description</th>\n </tr>\n <tr>\n <td class=\"\">init</td>\n <td class=\"\">Interactively creates a <span class=\"inline-code\">.stencil</span> file, which configures how to run a BigCommerce store locally.</td>\n </tr>\n <tr>\n <td class=\"\"><A NAME=\"startcmd\"></a>start</td>\n <td class=\"\">Starts up the BigCommerce store, using theme files in the current directory. \n <br><p></p>\n<b>Note:</b> If <span class=\"inline-code\">stencil start</span> generates an <span class=\"inline-code\">Unauthorized, please use a valid username/token</span> error: Please make sure that the <span class=\"inline-code\">.stencil</span> file contains the correct store URL (and, for OAuth, correct <NOBR><a href=\"/docs/initializing-stencil#https\">URL prefix</a></nobr>). Also, verify that you have copied the correct credentials, as outlined <a href=\"/docs/copying-a-token-to-initialize-stencil\">here</a>. If you continue to get the same error, please reissue tokens, as outlined <a href=\"/docs/issuing-and-reissuing-tokens\">here</a>.\n </td>\n </tr>\n \n <!-- <tr>\n <td class=\"\" colspan=\"2\"><div class=\"block-edit-callout type-{{'warning'}}<span class=\"indent2\">(<b>Note:</b> If <span class=\"inline-code\">stencil start</span> generates an <span class=\"inline-code\">Unauthorized, please use a valid username/token</span> error, please see troubleshooting instructions <a href=\"/docs/running-stencil-locally#TokenErrors\">here</a>.)</span></div></td>\n<td class=\"\"></td>\n </tr> -->\n \n <tr>\n <td class=\"\"><A NAME=\"bundlecmd\"></a>bundle</td>\n <td class=\"\">Bundles up the theme into a structured .zip file, which can be uploaded to BigCommerce. <NOBR>(Please see restrictions</nobr> <a href=\"/docs/uploading-a-custom-theme#restrix\">here</a>.)</td>\n </tr>\n \n <tr>\n <td class=\"\"><A NAME=\"pushcmd\"></a>push</td>\n <td class=\"\">Bundles up the theme into a structured .zip file; then directly uploads (pushes) the .zip to BigCommerce. <NOBR><NOBR>(Please see</nobr> usage instructions <a href=\"/docs/bundling-submitting#push\">here</a>. The same <a href=\"/docs/uploading-a-custom-theme#restrix\">restrictions</a> apply as for the <span class=\"inline-code\">bundle</span> command.)</td>\n </tr>\n \n <tr>\n <td class=\"\">help &lt;cmd&gt;</td>\n <td class=\"\">Displays help for the specified &lt;cmd&gt;.</td>\n </tr> \n</table>\n\n\n<table>\n <tr>\n <th>Option</th>\n <th>Description</th>\n </tr>\n <tr>\n <td class=\"\">-h, --help</td>\n <td class=\"\">Outputs usage information.</td>\n </tr>\n <tr>\n <td class=\"\">-V, --version</td>\n <td class=\"\">Outputs the version number (which is read from <span class=\"inline-code\">&lt;theme-name&gt;/package.json</span>).</td>\n </tr>\n</table>\n\n\n<H2> <a name=\"startopt\"></a> Startup Options </h2>\n\nTo see Stencil CLI's additional options for the <span class=\"inline-code\">stencil start</span> command (described <a href=\"#startcmd\">above</a>), enter <!--any of--> the following on your command line:<br>\n\n<p></p><pre>\nstencil help start <!--\nstencil -h start -->\n</pre>\n\n<p></p>Your terminal window will display currently supported options, as follows:\n\n<p></p>\n<table>\n <tr>\n <th>Option</th>\n <th>Description</th>\n <tr>\n <td class=\"\">-e</td>\n <td class=\"\">Also starts Theme Editor, as a parallel server, on its default port: <a href=\"http://localhost:8181\">http://localhost:8181</a>.</td>\n </tr>\n <tr>\n <td class=\"\"><NOBR>-e --theme-editor-port &lt;port-number&gt;</nobr></td>\n <td class=\"\">Also starts Theme Editor, as a parallel server, on the specified <NOBR>&lt;port-number&gt;</nobr>. (<NOBR>The &lt;port-number&gt;</nobr> parameter can be between 1024 and 65535.)</td>\n </tr>\n\n <tr>\n <td class=\"\" colspan=\"2\"><div class=\"block-edit-callout type-warning\">(<b>Note:</b> Theme Editor's initial release has been tested only on the Chrome browser.)</span></div></td>\n <!-- <td class=\"\"></td> -->\n </tr>\n \n <tr>\n <td class=\"\"><NOBR>-n, --no-cache</nobr></td>\n <td class=\"\">Disables caching of API resource data per storefront page. (<NOBR>To re-enable</nobr> caching, restart Stencil without these options.)</td>\n </tr>\n <tr>\n <td class=\"\"><NOBR>-o, --open</nobr></td>\n <td class=\"\">Automatically opens the default browser.</td>\n </tr>\n <tr>\n <td class=\"\"><NOBR>-t, --test</nobr></td>\n <td class=\"\">Enables QA mode, which bundles all JavaScript to accelerate local testing.</td>\n </tr>\n <tr>\n <td class=\"\">--tunnel</td>\n <td class=\"\">Creates a tunnel URL, pointing to your local server, that anyone can use.</td>\n </tr>\n <tr>\n <td class=\"\"><NOBR>-v &lt;name&gt;,</nobr> <NOBR>--variation &lt;name&gt;</nobr></td>\n <td class=\"\">Selects a theme variation to use while developing.</td>\n </tr>\n</table>" } [/block] ## <a name="pushopt"></a> Push Options To see Stencil CLI's additional options for the `stencil push` command (described [above](#pushcmd")), enter the following on your command line: ``` stencil help push ``` Your terminal window will display supported options, notably including: [block:html] { "html": "<table>\n <tr>\n <th>Option</th>\n <th>Description</th>\n <tr>\n <td class=\"\">-f &lt;filename&gt;, --file &lt;filename&gt;</td>\n <td class=\"\">Specifies the filename of a bundle to upload.\n</td>\n </tr>\n</table>" } [/block] You can use this option in cases where you have already run either `stencil push` or `stencil bundle` to [bundle your theme](/docs/bundling-submitting#ship-zip-small), but the resulting .zip file has not yet uploaded to BigCommerce. Use the `filename` parameter to identify the .generated .zip file in your theme directory. When you run `stencil push` with this option, Stencil CLI will skip all its bundling steps and diagnostics. It will proceed directly to [uploading the specified file](/docs/bundling-submitting#bundled), displaying its `Processing` progress bar to show upload status.