Skip to main content

A simple terminal viewer for Reddit (Terminal UI for Reddit)

Project description

Terminal UI for Reddit (TUIR)

A text-based interface (TUI) to view and interact with Reddit from your terminal.

title image

pypi gitlab-ci coverage

Table of Contents

June 2026 news

Reddit limited access to their API.

Now, only logged-in browsing is possible. Make sure autologin is set to True in settings.

Next, it is not possible to acquire oauth_client_id and oauth_client_secret from https://www.reddit.com/prefs/apps/ while still needed to provide in settings. I filled form to get a shared one. In the meantime, if you have few of them, consider sharing one to newcomers.

Installation

PyPI package

TUIR is available on PyPI and can be installed with pip:

$ pip install tuir-continued

From source

$ git clone https://gitlab.com/Chocimier/tuir.git
$ cd tuir
$ python setup.py install

Windows

TUIR is not supported on Windows, due to a lack of resources and interest. Sorry!

Migration from RTV

If you are migrating from RTV to TUIR, you can simply rename your old config directory/config file:

$ mv ~/.config/rtv ~/.config/tuir
$ mv ~/.config/tuir/rtv.cfg ~/.config/tuir/tuir.cfg

Usage

To run the program, type:

$ tuir

Controls

Move the cursor using either the arrow keys or Vim style movement:

  • Press and to scroll through submissions
  • Press to view the selected submission and to return
  • Press space-bar to expand/collapse comments
  • Press u to login (this requires a web browser for OAuth)
  • Press ? to open the help screen

Press / to open the navigation prompt, where you can type things like:

  • /front
  • /r/commandprompt+linuxmasterrace
  • /r/programming/controversial
  • /u/me
  • /u/multi-mod/m/art
  • /domain/github.com

See CONTROLS for the full list of commands.

Settings

Configuration File

Configuration files are stored in the {HOME}/.config/tuir/ directory.

Check out tuir.cfg for the full list of configurable options. You can clone this file into your home directory by running:

$ tuir --copy-config

Viewing Media Links

You can use mailcap to configure how TUIR will open different types of links.

title image

A mailcap file allows you to associate different MIME media types, like image/jpeg or video/mp4, with shell commands. This feature is disabled by default because it takes a few extra steps to configure. To get started, copy the default mailcap template to your home directory.

$ tuir --copy-mailcap

This template contains examples for common MIME types that work with popular reddit websites like imgur, youtube, and gfycat. Open the mailcap template and follow the instructions listed inside.

Once you've setup your mailcap file, enable it by launching tuir with the tuir --enable-media flag (or set it in your tuir.cfg)

Environment Variables

The default programs that TUIR interacts with can be configured through environment variables:

$TUIR_EDITOR A program used to compose text submissions and comments, e.g. vim, emacs, gedit
If not specified, will fallback to $VISUAL and $EDITOR in that order.
$TUIR_BROWSER A program used to open links to external websites, e.g. firefox, google-chrome, w3m, lynx
If not specified, will fallback to $BROWSER, or your system's default browser.
$TUIR_URLVIEWER A tool used to extract hyperlinks from blocks of text, e.g. urlview, urlscan
If not specified, will fallback to urlview if it is installed.

Clipboard

TUIR supports copying submission links to the OS clipboard. Data being copied is piped into a command specified by the configuration option clipboard_cmd. If this option is not set, the command will default to pbcopy w on Darwin systems (OSX), and xclip -selection clipboard on Linux.

Themes

Themes can be used to customize the look and feel of TUIR

Solarized Dark

Solarized Light

Papercolor

Molokai

You can list all installed themes with the --list-themes command, and select one with --theme. You can save your choice permanently in your tuir.cfg file. You can also use the F2 & F3 keys inside of TUIR to cycle through all available themes.

For instructions on writing and installing your own themes, see THEMES.md.

FAQ

Why am I getting an error during installation/when launching tuir?

If your distro ships with an older version of python 2.7 or python-requests, you may experience SSL errors or other package incompatibilities. The easiest way to fix this is to install tuir using python 3. If you don't already have pip3, see http://stackoverflow.com/a/6587528 for setup instructions. Then do

$ sudo pip uninstall tuir-continued
$ sudo pip3 install -U tuir-continued
Why do I see garbled text like M-b~@M-" or ^@?

This type of text usually shows up when python is unable to render unicode properly.

  1. Try starting TUIR in ascii-only mode with tuir --ascii
  2. Make sure that the terminal/font that you're using supports unicode
  3. Try setting the LOCALE to utf-8
  4. Your python may have been built against the wrong curses library, see here and here for more information
How do I run the code directly from the repository?

This project is structured to be run as a python module. This means that you need to launch it using python's -m flag. See the example below, which assumes that you have cloned the repository into the directory ~/tuir_project.

$ cd ~/tuir_project
$ python3 -m tuir
Can I use multiple accounts persistenly?

Yes, simply start tuir with --user yourusername. The refresh token and history will be preserved on a per-user basis.

This does mean you need to restart the program (or simply open multiple) if you want to be another user. There's no on-the-fly switching currently.

Current development status

Tuir-continued is meant as low activity maintainance, to keep the thing operational in face of changes in Python, libraries and Reddit API.

Contributions are still welcome. Before writing any code, please read the Contributor Guidelines.

License

This project is distributed under the GPLv3 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tuir_continued-1.32.1.tar.gz (216.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tuir_continued-1.32.1-py2.py3-none-any.whl (187.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file tuir_continued-1.32.1.tar.gz.

File metadata

  • Download URL: tuir_continued-1.32.1.tar.gz
  • Upload date:
  • Size: 216.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for tuir_continued-1.32.1.tar.gz
Algorithm Hash digest
SHA256 70fa912a2ae86ecdccb513cdeb956b5fc8a629720f079a735b5b3cbafb9abb2e
MD5 7ad5b0b32a379e53f7fff928c9d611ba
BLAKE2b-256 dd505eb797aef9e03335cc04178f3123d3b5a8781a6c8e4d680b6065e2b2a479

See more details on using hashes here.

File details

Details for the file tuir_continued-1.32.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for tuir_continued-1.32.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8c3a6f190bf431f793e263046abc619526dfd0f89854b32e6b692fa78690df68
MD5 d3b3ac6c0e0eb05a16c52e0e7a959c1b
BLAKE2b-256 a433fc6b7662f71a5bfea7b1daa40cb1847785cf75e6a7f03d5865efa5f49f7d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page