Project

posthaven_theme

0.0
No commit activity in last 3 years
No release in over 3 years
posthaven_themeposthaven/posthaven_themeHomepageDocumentationSource CodeBug TrackerWiki
Command line tool to help with developing Posthaven themes. Provides simple commands to download, upload and delete files from a theme. Also includes the watch command to watch a directory and upload files as they change.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
8,260
Stars
9
Forks
0
Watchers
5
 Releases
Current version
0.1.3
Total releases
4
First release
2016-08-08
Latest release
2020-03-11
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2015-11-20
Reverse Dependencies
0

 Dependencies

Development

minitest
>= 5.0.0
rake
>= 0

Runtime

filewatcher
~> 1.0
httparty
~> 0.13.0
json
~> 1.8.0
mimemagic
>= 0
thor
~> 0.16
 Project Readme

Posthaven Theme

The posthaven_theme gem provides command line tools for developing a Posthaven theme on your computer and pushing updates to Posthaven.

Requirements

Ruby

This gem requires Ruby 2.0 or above.

Posthaven API Key

Log in and get your Posthaven account API key here.

Installation

To install the posthaven_theme gem use 'gem install' (you might have use 'sudo gem install')

gem install posthaven_theme

to update to the latest version

gem update posthaven_theme

Usage

The gem installs the phtheme CLI program.

List available commands

phtheme help

Generate a configuration file. For your API key see above.

phtheme configure api-key

Upload all files

phtheme upload

Upload a single theme file

phtheme upload layouts/theme.liquid

Remove a theme file

phtheme remove assets/layout.liquid

Completely remove all old theme files and replace them with current local versions

phtheme replace

Watch the current theme directory and upload any files as they change

phtheme watch

Configuration

Running phtheme configure generates config.yml file in the base directory of your theme. If you are storing your theme in version control it is highly recommended that you DO NOT store this file in version control, e.g. in git add it to your .gitignore.

config.yml has the following options:

  • api_key – Your Posthaven API key
  • theme_id – The ID of the theme to edit. The easiest way to populate the theme id is via the configure command above.

See the phtheme configure command above for one step setup of the config.yml file.

Thanks

A huge thanks to Shopify for their shopify_theme gem upon which this is based.