2015-04-05 21:11:20 -05:00
2015-04-05 18:31:09 -07:00
2015-02-08 00:10:03 -08:00
2015-03-30 14:03:14 +02:00
2015-03-20 22:52:41 -04:00

Latest Version Supported Python versions

Reddit Terminal Viewer

Browse Reddit from your terminal

  1. Overview

  2. Installation

  3. Configuration

  4. Usage

  5. Changelog

Overview

http://i.imgur.com/W1hxqCt.png

RTV is built in python using the curses library, and is compatible with most terminal emulators on Linux and OS X.

Installation

Install using pip

$ sudo pip install rtv

Or clone the repository

$ git clone https://github.com/michael-lazar/rtv.git
$ cd rtv
$ sudo python setup.py install

The installation will place a script in the system path

$ rtv
$ rtv --help

Configuration

RTV will read a configuration file located at $XDG_CONFIG_HOME/rtv/rtv.cfg or ~/.config/rtv/rtv.cfg if $XDG_CONFIG_HOME is not set. This can be used to avoid having to re-enter login credentials every time the program is launched. Each line in the file will replace the corresponding default argument in the launch script.

Example config:

[rtv]
username=MyUsername
password=MySecretPassword

# Log file location
log=/tmp/rtv.log

# Default subreddit
subreddit=CollegeBasketball

# Default submission link - will be opened every time the program starts
# link=http://www.reddit.com/r/CollegeBasketball/comments/31irjq

# Enable unicode characters (experimental)
# This is known to be unstable with east asian wide character sets
# unicode=true

RTV allows users to compose comments and replys using their preferred text editor (vi, nano, gedit, etc). Set the environment variable RTV_EDITOR to specify which editor the program should use.

$ export RTV_EDITOR=gedit

Usage

RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different.

Global Commands

/ or j/k:

Scroll to the prev/next item

a/z:

Upvote/downvote the selected item

ENTER or o:

Open the selected item in the default web browser

r:

Refresh the current page

u:

Login and logout of your user account

?:

Show the help screen

q:

Quit

Subreddit Mode

In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit.

or l:

View comments for the selected submission

/:

Open a prompt to switch subreddits

f:

Open a prompt to search the current subreddit

p:

Post a new submission to the current subreddit

The / prompt accepts subreddits in the following formats

  • /r/python

  • /r/python/new

  • /r/python+linux supports multireddits

  • /r/front will redirect to the front page

  • /r/me will display your submissions

Submission Mode

In submission mode you can view the self text for a submission and browse comments.

or h:

Return to subreddit mode

or l:

Fold the selected comment, or load additional comments

c:

Post a new comment on the selected item

Changelog

1.2

  • Post submissions with the p command in subreddit mode.

  • View your submissions on /r/me.

  • Gilded comments and posts are denoted with ✪.

  • New config file location (~/.config/rtv/rtv.cfg).

  • Login and logout with the u key.

  • Search the subreddit with the f key

  • Links may be opened with ENTER or o.

1.1

  • Post comments using your text editor.

Description
Browse Reddit from your terminal
Readme 52 MiB
Languages
Python 99.3%
Roff 0.4%
Shell 0.2%