Terminal UI for Reddit (TUIR)
A text-based interface (TUI) to view and interact with Reddit from your terminal.
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.
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.
- Try starting TUIR in ascii-only mode with
tuir --ascii- Make sure that the terminal/font that you're using supports unicode
- Try setting the LOCALE to utf-8
- 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
-mflag. 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.
Metadata
Release files for tuir-continued 1.32.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| tuir_continued-1.32.3.tar.gz | 218.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tuir_continued-1.32.3-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 406.8 kB
Release files / tuir_continued-1.32.3.tar.gz
| Download URL | tuir_continued-1.32.3.tar.gz |
|---|---|
| Size | 218.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
29c3448b8e35b7e3459b558f5791fbd89d4bc8b9a9f869b0eb5cf5e2457bd451
|
|
BLAKE2b-256 checksum How to use checksums |
66321e2a907d1b9fa9488d65d61e072221e00bc3d47d31c9f049f8c6d96c67dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Release files / tuir_continued-1.32.3-py2.py3-none-any.whl
| Download URL | tuir_continued-1.32.3-py2.py3-none-any.whl |
|---|---|
| Size | 188.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
f1b61898d9c13ba9160691c626838705a709599ae2661131d0f156743e8108ed
|
|
BLAKE2b-256 checksum How to use checksums |
6b765e512f5e6af31619a72860c5bbd6910d1cb47c28114dd0fe4364860ee53c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Security for tuir-continued 1.32.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.