https://github.com/pyro2927/blitzcrank
Copy down remote files and sort them into local directories with ease.
https://github.com/pyro2927/blitzcrank
Last synced: 3 months ago
JSON representation
Copy down remote files and sort them into local directories with ease.
- Host: GitHub
- URL: https://github.com/pyro2927/blitzcrank
- Owner: pyro2927
- License: gpl-2.0
- Created: 2013-11-10T18:16:41.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-05-11T01:30:45.000Z (about 10 years ago)
- Last Synced: 2025-12-27T03:45:26.966Z (7 months ago)
- Language: Ruby
- Size: 457 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blitzcrank
[](http://leagueoflegends.wikia.com/wiki/Blitzcrank)
Copy down remote files and sort them into local directories with ease.
## Table of Contents
* [Installation](#installation)
* [Recommendations](#recommendations)
* [Setup](#setup)
* [Sample Config File](#sample-config-file)
* [Sample Directory Structure](#sample-directory-structure)
* [Usage](#usage)
* [Mana Barrier](#mana-barrier)
* [Rocket Grab](#rocket-grab)
* [Overdrive](#overdrive)
* [Contributing](#contributing)
_Generated with [tocify](https://github.com/pyro2927/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](http://sickbeard.com/) and [CouchPotato](https://couchpota.to/), 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](#mana-barrier). If you would also like to limit the connection speed rsync uses, add `:bwlimit: `. `:bwlimit: 2000` would limit transfer speeds to 2000kb/second.
### Sample Directory Structure
When transfering TV shows, they will be structured in the format of `////.mkv`.
/Volumes/Public/TV\ Shows/
├── Pioneer One
│ ├── Season\ 1
├── SHOW2
│ ├── Season\ 1
│ ├── Season\ 2
│ ├── Season\ 3
│ └── Season\ 4
└─── SHOW3
├── Season\ 1
└── Season\ 2
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](http://www.imdb.com/).
## 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