https://github.com/lgug2z/sgrab
Grab an episode file from a seedbox running Sonarr
https://github.com/lgug2z/sgrab
seedbox sonarr
Last synced: about 1 year ago
JSON representation
Grab an episode file from a seedbox running Sonarr
- Host: GitHub
- URL: https://github.com/lgug2z/sgrab
- Owner: LGUG2Z
- Created: 2017-09-14T11:43:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-15T11:54:56.000Z (almost 9 years ago)
- Last Synced: 2025-03-25T13:45:39.789Z (over 1 year ago)
- Topics: seedbox, sonarr
- Language: Go
- Homepage:
- Size: 15.6 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sgrab
sgrab is a command line utility for grabbing episodes of TV shows from a
seedbox running [Sonarr](https://sonarr.tv/).
## Requirements
* [Go](https://github.com/golang/go)
## Install
The latest version of `sgrab` can be installed using `go get`.
```
go get -u github.com/LGUG2Z/sgrab
```
Make sure that `$GOPATH` is set correctly that and that `$GOPATH/bin` is in your `$PATH`.
The `sgrab` executable will be installed under the `$GOPATH/bin` directory.
### Required information
In order to use `sgrab` the following information is required:
* Sonarr URL
* Sonarr API key
* Seedbox address
* Seedbox login username
This information can either be set in your shell rc:
```bash
export SGRAB_SONARR=https://mybox.com/sonarr/
export SGRAB_API_KEY=xxx
export SGRAB_SEEDBOX=mybox.com
export SGRAB_USERNAME=xxx
```
Or set using the relevant flags
```
Flags:
--api-key string Sonarr API key
-e, --episode string Episode number
-h, --help help for sgrab
--port string SSH port number for seedbox
--seedbox string Seedbox address
-s, --series string Series name
--sonarr string Sonarr url
--ssh-key string Path to SSH key
--username string Seedbox login username
```
## Usage
The key at `$HOME/.ssh/id_rsa` is used to establish a secure connection to the
seedbox to download the file. A different key can be provided using the `--ssh-key`
flag.
sgrab will by default try to connect to the seedbox on port 22. An alternative
port can be specified using the `--port` flag.
For sgrab to make a successful connection to download the requested file, the
seedbox should have been connected to before via SSH and an entry for the seedbox
should exist in `$HOME/.ssh/known_hosts`.
The `--series` flag is case-insensitive, however the name of the series must
otherwise match the primary name given to a series by Sonarr. Series that have
multi-word titles should be quoted.
The `--episode` flag uses the format "s01e02", with mandatory leading zeroes.
Example:
```bash
sgrab --series "Terrace House: Boys x Girls Next Door" --episode s01e01
```