Home

[html]

<div class="marketing-markdown">
<h1 id="shopify-theme-kit">Shopify Theme Kit</h1>

<p>Theme Kit is a single binary that has no dependencies. Download the application
and with a tiny bit of setup you’re off to the theme creation races.</p>

<p>Using Theme Kit will enable you to</p>

<ul>
<li>Upload Themes to Multiple Environments</li>
<li>Fast Uploads and Downloads</li>
<li>Watch for local changes and upload automatically to Shopify</li>
<li>Works on Windows, Linux and macOS</li>
</ul>

<h2 id="installation">Installation</h2>

<h3 id="automatic-installation">Automatic Installation</h3>

<p>If you are on Mac or Linux you can use the following installation script to automatically
download and install Theme Kit for you. Please follow the directions outputted to your
console to change your bash profile so that you will have access to the <code class="highlighter-rouge">theme</code> command</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>curl -s https://raw.githubusercontent.com/Shopify/themekit/master/scripts/install | sudo python
</code></pre>
</div>

<h3 id="homebrew">Homebrew</h3>

<p>If you have <a href="http://brew.sh/">homebrew</a> installed you can install Theme Kit by running the following commands.</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>brew tap shopify/shopify
brew install themekit
</code></pre>
</div>

<h3 id="windows-installer">Windows Installer</h3>

<p>Download and run the installer:</p>

<ul>
<li><a href="https://github.com/Shopify/themekit/releases/download/v0.6.10/themekit-setup-64.exe">windows-64</a></li>
<li><a href="https://github.com/Shopify/themekit/releases/download/v0.6.10/themekit-setup-32.exe">windows-32</a></li>
</ul>

<h3 id="manual-installation">Manual Installation</h3>

<p>Download and unzip the latest release.</p>

<table>
<thead>
<tr>
<th style="text-align: left">OS</th>
<th style="text-align: left">Architecture</th>
<th style="text-align: left">&nbsp;</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">macOS</td>
<td style="text-align: left">64-bit</td>
<td style="text-align: left"><a href="https://github.com/Shopify/themekit/releases/download/v0.6.10/darwin-amd64.zip">download</a></td>
</tr>
<tr>
<td style="text-align: left">Windows</td>
<td style="text-align: left">64-bit</td>
<td style="text-align: left"><a href="https://github.com/Shopify/themekit/releases/download/v0.6.10/windows-amd64.zip">download</a></td>
</tr>
<tr>
<td style="text-align: left">Windows</td>
<td style="text-align: left">32-bit</td>
<td style="text-align: left"><a href="https://github.com/Shopify/themekit/releases/download/v0.6.10/windows-386.zip">download</a></td>
</tr>
<tr>
<td style="text-align: left">Linux</td>
<td style="text-align: left">64-bit</td>
<td style="text-align: left"><a href="https://github.com/Shopify/themekit/releases/download/v0.6.10/linux-amd64.zip">download</a></td>
</tr>
<tr>
<td style="text-align: left">Linux</td>
<td style="text-align: left">32-bit</td>
<td style="text-align: left"><a href="https://github.com/Shopify/themekit/releases/download/v0.6.10/linux-386.zip">download</a></td>
</tr>
</tbody>
</table>

<h2 id="get-api-access">Get API Access</h2>

<p>You will need to set up an API key to add to our configuration and create a connection
between your store and Theme Kit. The API key allows Theme Kit to talk to and access
your store, as well as its theme files.</p>

<p>To do so, log into the Shopify store, and create a private app. In the Shopify
Admin, go to Apps and click on View private apps. From there, click Generate API
credentials to create your private app. Make sure to set the permissions of <strong>Theme
templates and theme assets</strong> to have <strong><em>Read and write</em></strong> access in order to generate the
appropriate API credentials, then click Save.</p>

<p><img src="/themekit/assets/images/shopify-local-theme-development-generate-api.gif"></p>

<p>Fill out the information at the top and set the permissions of <code class="highlighter-rouge">Theme templates and theme assets</code> to
read and write access. Press <code class="highlighter-rouge">Save</code> and you will be presented with the next screen. In it you will
see your access credentials. Please make note of the password. You will need it later.</p>

<p><img src="/themekit/assets/images/private-app-password.png"></p>

<h2 id="use-a-new-theme">Use a new theme.</h2>

<p>If you are starting from scratch and want to get a quick start, run the following:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>theme bootstrap –password<span class="o">=[</span>your-password] –store<span class="o">=[</span>your-store.myshopify.com]
</code></pre>
</div>

<p>This will create a new theme for your online store from the <a href="https://shopify.github.io/Timber/">Timber</a> template. Then
it will download all those assets from Shopify and automatically create a <code class="highlighter-rouge">config.yml</code> file for you.</p>

<h2 id="configure-an-existing-theme">Configure an existing theme.</h2>

<p>To connect an existing theme, you need the theme’s ID number. The easiest way to
get your theme’s ID number is to go to the Theme Editor click on Edit HTML/CSS and
copy the theme ID number from the URL — it will be last several digits after mystore.myshopify.com/admin/themes/.</p>

<p><img src="/themekit/assets/images/shopify-local-theme-development-theme-id.gif"></p>

<p>Then once you have noted your theme ID, run the following commands:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c"># create configuration</span>
theme configure –password<span class="o">=[</span>your-password] –store<span class="o">=[</span>you-store.myshopify.com] –themeid<span class="o">=[</span>your-theme-id]
<span class="c"># download and setup project in the current directory</span>
theme download
</code></pre>
</div>

</div>

[/html]