pxlshopify-cli-preview
v0.1.5
Published
Command-line interface for Pixelcabin Shopify Tools.
Downloads
1
Readme
Pixelcabin Shopify CLI
This is the command-line interface for Pixelcabin Shopify Tools. It downloads our template stack and installs the dependencies.
Requirements
You'll need the following software installed to get started.
- Node.js: Use the installer provided on the NodeJS website.
- With Node installed, run
[sudo] npm install -g gulp bower
.
- With Node installed, run
- Git: Use the installer for your OS.
- Windows users can also try Git for Windows.
Installing
The Pixelcabin Shopify CLI is installed through npm.
npm install -g pxlshopify-cli
This will add the pxlshopify
command to your system.
Setup Instructions
New Store
- Setup the store on Shopify (shortcut:
pxlshopify store_setup new
) - Setup a private app on your store (shortcut:
pxlshopify store_setup app --store=STORENAME
), and take note of the api key and api password - Within your store, get the theme id of the starter theme (go to the web editor for the theme, and copy the ID from the end of the url)
pxlshopify new SHOPNAME APIKEY APIPASSWORD THEMEID
Day-to-day use
- The app will default to a development environment - to change to production, run
pxlshopify env production
- run
grunt watch
- All SCSS files should be created in
src/scss
, and included via@import
withinapplication.scss
- All JS files should be created in
src/js
- All other assets should be created in
shop/assets
Updating
The CLI periodically gets updates that add features or fix bugs. Use npm to upgrade the CLI to the newest version.
npm update -g pxlshopify-cli
To check what version you currently have, use -v
.
pxlshopify -v
Commands
New
Downloads and installs a Pixelcabin Shopify Tools project, into a folder named after the store.
pxlshopify new <store-name> <api_key> <api_password> <theme_id>
You can include Foundation with the --foundation
flag.
pxlshopify new <store-name> <api_key> <api_password> <theme_id> --foundation
Help
Lists all available commands in the CLI.
pxlshopify help
Add a command name at the end to learn how a specific command works.
pxlshopify help new