Blitzcrank

Copy down remote files and sort them into local directories with ease.

Table of Contents

• Installation
• Recommendations
• Setup
  • Sample Config File
  • Sample Directory Structure
• Usage
  • Mana Barrier
  • Rocket Grab
  • Overdrive
• Contributing

Generated with tocify

Installation

Install it with:

$ gem install blitzcrank

Blitzcrank transfers files via rsync.

Install on OS X:

$ brew install rsync

Install on Debian:

$ sudo apt-get install rsync

Recommendations

Blitzcrank works best at pulling down torrents from a remote server. Manually finding torrents is SO 19th century. Automatically fetch torrents with systems like Sickbeard and CouchPotato, trust me, it's awesome.

Setup

Blitzcrank requires a small amount of setup. First, it mainly does transfers via ssh of a remote host and your local machine. In order to do so you'll have to have a yaml config file at ~/.blitzcrank.

Sample Config File

$ cat ~/.blitzcrank
---
:base_tv_dir: "/Volumes/Public/TV Shows/"
:base_movie_dir: "/Volumes/Public/Movies/"
:remote_user: "root"
:remote_host: "subdomain.domain.tld"
:remote_base_dir: "~/torrents/"

This can be generated with Mana Barrier. If you would also like to limit the connection speed rsync uses, add :bwlimit: <kb/sec>. :bwlimit: 2000 would limit transfer speeds to 2000kb/second.

Sample Directory Structure

When transfering TV shows, they will be structured in the format of /<TV_BASE_DIR>/<SHOW_NAME>/<SEASON NUMBER>/<EPISODE>.mkv.

/Volumes/Public/TV\ Shows/

Movies are all contained in a single directory, so a folder structure isn't required.

Usage

Mana Barrier

$ manabarrier

Mana Barrier will populate a sample config file if you do not have one already in place. The location for this is in ~/.blitzcrank.

Rocket Grab

$ rocketgrab
$ rocketgrab "search1"
$ rocketgrab "search1" "search 2" ...

Use rocketgrab to pull down remote files and sort them into local directories.

Overdrive

Overdrive is best suited for cron jobs and automated scheduling. It copies down any TV shows that match an existing folder, and any movies that are verified via IMDB.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request