|
1 | 1 | # Oscar |
2 | 2 | [](https://travis-ci.org/asimpson/oscar) |
3 | 3 |
|
4 | | -A CLI application to download Sesame Street videos from PBS. Ideally run in cron or another scheduler. |
| 4 | +A CLI application to download full TV episodes from PBS. Ideally run in `cron` or another scheduler. |
5 | 5 |
|
6 | 6 | ## Example |
7 | 7 | `@hourly oscar -so /mnt/nas/videos/` |
8 | 8 |
|
| 9 | +## Installation |
| 10 | + |
| 11 | +### Pre-built binaries |
| 12 | +Pre-built binaries are available via [Github releases](https://github.com/asimpson/oscar/releases) (which are built by [TravisCI](https://travis-ci.org/asimpson/oscar)). |
| 13 | + |
| 14 | +### Cargo |
| 15 | +`cargo install oscar` |
| 16 | + |
| 17 | +### From source |
| 18 | +Requires Rust and Cargo to be installed on the host system. |
| 19 | + |
| 20 | +To build: `cargo build --release` |
| 21 | + |
| 22 | +## Subcommands |
| 23 | +`list`: View available shows in "slug" format, e.g. `sesame-street`. |
| 24 | + |
| 25 | +FYI `oscar` defaults to downloading Sesame Street episodes. |
| 26 | + |
9 | 27 | ## Options |
10 | 28 | `-d --dry-run`: run without actually downloading any files. |
11 | 29 |
|
12 | 30 | `-s --silent`: Do not log anything. |
13 | 31 |
|
14 | | -`-o --output`: Where to save movies, defaults to `/tmp/`. |
| 32 | +`-o --output`: Where to save episodes, defaults to `/tmp/`. |
15 | 33 |
|
16 | 34 | `-S --show-slug`: What show to download. Get the slug by running `oscar list`. |
17 | 35 |
|
18 | | -## Subcommands |
19 | | -`list`: View available shows in "slug" format, e.g. `sesame-street`. |
20 | | - |
21 | 36 | ## Misc |
22 | | -Please note that each episode of Sesame Street at ~720p quality is `~500MB`. If you are on a metered or a slow connection this may be a problem. |
| 37 | +Please note that each episode at ~720p quality is around `500MB`. If you are on a metered or a slow connection this may be a problem. |
23 | 38 |
|
24 | 39 | Every episode that is downloaded gets logged by appending its ID to a text file `~/.oscar_history`. This file is checked every time `oscar` runs to validate if an episode is new or not. |
25 | 40 |
|
26 | | -Currently a new episode cycles in on Friday at 1am EST. |
| 41 | +Currently new episodes cycle in on Friday at 1am EST. |
0 commit comments