-
Notifications
You must be signed in to change notification settings - Fork 0
Home
These instructions assume you're on Mac OS. Usage on Linux should be similar.
What you'll need to use Tap Utils:
- A backup.tap backup file from TapCellar by Gravity Well Group and the TapCellarBackup.json file contained within it
- The scripts from the Tap Utils repository you're looking at right now
- Ruby - installed by default on modern Macs, availability on other systems not guaranteed
- A console or terminal to run the scripts - we'll use Terminal.app
Let's get started.
It's easy to create a backup of your TapCellar data. Swipe from the left, then select "Preferences" and "Backup Your Database".
There are several options for backing up your data. The backup can be quite large — mine are over 30 MB — so choose a location that can accommodate a large file. I've used both Dropbox and AirDrop with success.
You'll end up with a backup.tap file. Note where you saved the file. Move it to a different location if you want, like your home folder.
Find the file and change the file name extension from .tap to .zip.
While you're changing the extension, I suggest changing the name of the file so you don't accidentally overwrite it with a future backup. Adding a date is a decent idea. For example, change the filename from backup.tap to backup_2014_12_18.zip, using the date of your actual backup, of course.
Now you can open the zip archive. On Mac OS, simply double-click the file. This creates a new folder containing all of the files within the backup.tap file.
Open this folder. The important file for our purposes is TapCellarBackup.json. We'll use it in a later step.
You need to download the Tap Utils scripts.
If you're at all comfortable using Git, the best method is cloning the repository. This lets you git pull or git fetch changes easily if there are updates or additions to the scripts.
If you're not, no problem. Just go to the Tap Utils repository page and click the Download ZIP button.
You'll end up with a tap-utils-master.zip file. Note where you saved the file. Move it to a different location if you want, like your home folder.
Now you can open the zip archive. On Mac OS, simply double-click the file. This creates a new folder containing all of the files within the tap-utils-master.zip file.
Run Terminal.app (it's in the Utilities folder within your Applications folder).
Change to the tap-utils-master folder. For example:
cd /Users/tpdorsey/tap-utils-master
The easy way to do this is to type cd, a space, then drag the cd tap-utils-master folder from Finder and drop it on the Terminal window. This adds the folder path to your command line automatically. Press Enter to run the command.
Now you can run the commands. If I did my job properly, the README.md file has pretty good instructions and examples for each script.
In each case, you need to begin the command with ruby, then a space, then the name of the script, then another space, then the location of your TapCellarBackup.json file.
Some of the utilities need additional flags or search words before the TapCellarBackup.json, which is always the last part of the command. See the README.md file for details.
You can type the path to your TapCellarBackup.json file or, as I demonstrated previously, drag the file from Finder and drop on the Terminal window where you need the path.
For example, to get a grade timeline, you'd run tap-timeline.rb like this:
ruby tap-timeline.rb stout /Users/tpdorsey/backup_2014_12_18/TapCellarBackup.json
If it works, the output shows up in your Terminal window. If not, you'll most likely get an error message like Error: File TapCellarBackup.json does not exist. Check the location of your TapCellarBackup.json file and try again.
Cheers!