LinuxCommandLibrary

tuir

Browse and use Reddit from the terminal

TLDR

Launch tuir

$ tuir
copy

Open a subreddit
$ </>[subreddit_name]
copy

Open a link
$ <o>
copy

Open a specific subreddit on launch
$ tuir -s [subreddit_name]
copy

Open external links using programs defined in the mailcap config
$ tuir --enable-media
copy

SYNOPSIS

tuir [options] [subreddit]

PARAMETERS

[subreddit]
    Optionally specify a subreddit to open directly upon launching tuir (e.g., 'programming').

--config <file>
    Specify an alternative path for the configuration file, overriding the default location.

--auth <file>
    Specify an alternative path for the authentication token file, where Reddit credentials are stored.

--version
    Show the program's version number and exit.

--clear-cache
    Clears the internal cache used by tuir and then exits. Useful for troubleshooting data inconsistencies.

--log <level>
    Set the logging verbosity level. Common levels include INFO, WARNING, ERROR, or DEBUG for detailed output.

--theme <name>
    Specify a pre-defined theme to use for the interface's color scheme and styling.

-h, --help
    Display a help message that lists all available command-line options and then exit.

DESCRIPTION

tuir is a powerful and highly configurable terminal user interface (TUI) client for browsing Reddit directly from your command line. It offers a fast and efficient way to navigate subreddits, view posts, read comments, and interact with the Reddit platform without the need for a web browser.

Written in Python, tuir provides a rich set of features including searching, upvoting, downvoting, commenting, subscribing to subreddits, and managing multiple user accounts. It supports viewing various content types, often leveraging external programs for images and videos. Designed for users who prefer a keyboard-driven workflow or operate in environments without graphical interfaces, tuir integrates seamlessly into a terminal-centric computing experience, offering a concise and productive way to consume Reddit content.

CAVEATS

tuir operates within the confines of your terminal, meaning its rendering capabilities are dependent on terminal support for features like true colors and Unicode characters. While it can display images and videos, it typically relies on external command-line viewers (like feh or mpv) which must be installed and configured separately.

Initial user authentication for Reddit often requires a temporary browser interaction to obtain the necessary tokens. As an unofficial third-party client, its functionality could be impacted by changes to Reddit's API, potentially requiring updates to the application.

KEYBINDINGS AND NAVIGATION

tuir is designed for keyboard-driven navigation, making it efficient for power users. Users can browse subreddits, posts, and comments, upvote, downvote, and interact with Reddit entirely through customizable keyboard shortcuts. Pressing '?' within the application typically displays a comprehensive help screen with common keybindings relevant to the current view.

CONFIGURATION

The application is highly configurable through a TOML-formatted configuration file (typically located at ~/.config/tuir/config.toml). This file allows users to extensively customize themes, keybindings, external helper applications for media, and various other aspects of the user interface and behavior to tailor tuir to their preferences.

HISTORY

tuir emerged as a modern and actively maintained alternative to the original Reddit Terminal Viewer (RTV), which saw periods of inactivity and lacked certain modern features. It was developed to address these limitations and introduce new functionalities, providing a robust and feature-rich experience for Reddit users who prefer a terminal-based interface.

Its development in Python allows for a high degree of customizability, cross-platform compatibility, and a more active development cycle compared to its spiritual predecessor.

SEE ALSO

rtv(1), lynx(1), elinks(1), curl(1)

Copied to clipboard