Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcdallas/gert
A command line tool to download media from Reddit
https://github.com/mcdallas/gert
cli media-downloader reddit reddit-api reddit-crawler reddit-scraper rust
Last synced: about 2 months ago
JSON representation
A command line tool to download media from Reddit
- Host: GitHub
- URL: https://github.com/mcdallas/gert
- Owner: mcdallas
- License: mit
- Created: 2022-11-03T21:51:12.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-11T19:01:59.000Z (about 1 year ago)
- Last Synced: 2024-10-31T11:32:15.407Z (2 months ago)
- Topics: cli, media-downloader, reddit, reddit-api, reddit-crawler, reddit-scraper, rust
- Language: Rust
- Homepage:
- Size: 225 KB
- Stars: 51
- Watchers: 5
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gert
A command line tool to download media from Reddit
* Supports:
- Reddit: PNG/JPG images, GIFs, Image galleries, videos
- Giphy: GIFs
- Imgur: Direct images, GIFVs and albums
- Gfycat/Redgifs: GIFs
- Streamable: videos
* GIF/GIFV from Imgur/Gfycat/Redgifs are downloaded as mp4
## Installation
### Prerequisites
There is a soft dependency on ffmpeg, for installation instructions follow this [link](https://www.ffmpeg.org/download.html).
You can skip it but without it:
* Videos hosted on reddit itself (v.redd.it) won't have sound
* Gifs won't be automatically converted to .mp4
#### Using cargo
If you already have Rust installed, you can install using `cargo`:
```shell script
cargo install gert
```
#### Using homebrew
```shell script
brew tap mcdallas/gert
brew install gert
```
#### Github Release
just grab the [latest release](https://github.com/mcdallas/gert/releases/latest) for your OS
## Running
Simply pass the names of the subreddits you want to download media from with (multiple) `-s` flags
```bash
gert -s wallpapers -s earthporn
```
To download media from a single post/collection just pass the url of the post
```bash
gert https://old.reddit.com/r/wallpapers/comments/tckky1/some_walls_from_my_collections_vol6/
```
## Command line options
```bash
Simple CLI tool to download media from Reddit
USAGE:
gert [FLAGS] [OPTIONS] --subreddit ...
FLAGS:
-c, --conserve-gifs Disable gif to mp4 conversion
--debug Show the current config being used
-r, --dry-run Dry run and print the URLs of saved media to download
-h, --help Prints help information
-H, --human-readable Use human readable names for files
-V, --version Prints version information
OPTIONS:
-e, --from-env Set a custom .env style file with secrets
-f, --feed Feed to download from [default: hot] [possible values: hot, new, top, rising]
-l, --limit Limit the number of posts to download [default: 25]
-m, --match Pass a regular expresion to filter the title of the post
-o, --output Directory to save the media to [default: .]
-p, --period Time period to download from [default: day] [possible values: now, hour, day,
week, month, year, all]
-s, --subreddit ... Download media from these subreddits
-u, --upvotes Minimum number of upvotes to download [default: 0]
ARGS:
URL of a single post to download
```
### Optional Authentication with Reddit
Authentication is not required but if you want a more generous rate limit you can create a new app in reddit and pass your credentials to gert
1. Create a new script application at https://www.reddit.com/prefs/apps
* Click on create an app at the bottom of the page
* Input a name for your application, for example: `gert`
* Choose "script" as the type of application
* Set "http://localhost:8080" or any other URL for the redirect url
* Click on "create app" - you should now see the application has been created
* Under your application name, you should see a random string - that is your client ID
* The random string next to the field "secret" is your client secret
2. Copy the client ID and client secret information returned
3. Create a .env file with the following keys, for example `gert.env`:
```shell script
CLIENT_ID=""
CLIENT_SECRET=""
USERNAME=""
PASSWORD=""
```
_NOTE_: If you have 2FA enabled, please make sure you set `PASSWORD=:<2FA_TOTP_token>` instead
### Credits
based on https://github.com/manojkarthick/reddsaver