Skip to content

🚀 👜 Shopify Theme Tools: Download, Watch and Deploy

Notifications You must be signed in to change notification settings

zachzurn/ShopifyCommandLine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shopify Tools

Shopify Tools is a project that provides tools for editing assets on shopify stores. Shopify Tools is written in the Go programming language.

Download --- Win --- Mac

go shopify tools

How to use

To configure your stores, you will need to create a shopify.json file that looks like the one below.

{
	"allowed_extensions" : [".txt"],
	"stores" : {
		"dev" : {
			"name" : "Shopify Dev",
			"folder" : "shopify-dev",
			"api_key": "STORE_API_KEY_GOES_HERE",
			"api_password": "STORE_API_PASSWORD_GOES_HERE",
			"shop": "STORE_URL_GOES_HERE.myshopify.com",
			"theme_id" : 00000000
		},
		"staging" : {
			"name" : "Shopify Staging",
			"folder" : "shopify-staging",
			"api_key": "STORE_API_KEY_GOES_HERE",
			"api_password": "STORE_API_PASSWORD_GOES_HERE",
			"shop": "STORE_URL_GOES_HERE.myshopify.com",
			"theme_id" : 00000000
		},
		"production" : {
			"name" : "Shopify Production",
			"folder" : "shopify-production",
			"api_key": "STORE_API_KEY_GOES_HERE",
			"api_password": "STORE_API_PASSWORD_GOES_HERE",
			"shop": "STORE_URL_GOES_HERE.myshopify.com",
			"theme_id" : 00000000
		},
	}
}

You can create as many stores as you want and name them however you want. Once you have your settings in place you can run the following commands.

Watch

Watches the folder specified in the "folder" field for changes and uploads/deletes changes.

watch [store] //Windows Example ./shopify.exe watch dev

Download

Downloads the entire theme to the folder specified in the "folder" field.

download [store] //Windows Example ./shopify.exe download production

Example folder structure using the above configuration.

Project Folder
  |--shopify.json
  |--shopify-dev
  |--shopify-staging
  |--shopify-production
  |--shopify.exe

Development

Want to contribute?

  • Configure dev, test and staging stores [DONE]

  • Download entire theme [DONE]

  • Watch for file changes and upload to shopify [DONE]

  • Safe Deploy files to Shopify for a theme with incremental upload/deletes and deploy preview [NOT IMPLEMENTED]

  • Force Deploy all files to shopify with no confirmation. For automated use. [NOT IMPLEMENTED]

  • Deploy one store's theme to another store with 'source deploy target' command [NOT IMPLEMENTED]

  • Copy products from one store to another [NOT IMPLEMENTED]

  • Import products using a JSON file [NOT IMPLEMENTED]

  • Encrypt and Decrypt shopify.json with password using 'settings lock' and 'settings unlock'. [NOT IMPLEMENTED]

  • See Functionality above and help with [NOT IMPLEMENTED] features

  • Test on OSX and Linux (Tested on Windows so far) and report/fix issues

About

🚀 👜 Shopify Theme Tools: Download, Watch and Deploy

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages