Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 

README.md

Actions Status PRs Welcome

TerminusBrowser - a terminal 4chan/Reddit browser

  1. Introduction
  2. Screenshots
  3. Hotkeys
  4. Configuration
  5. Contributing
  6. TODO List

Introduction

Previously known as commandChan.

Created out of a desire to browse 4chan at work, TerminusBrowser is turning into a general framework for browsing sites in the terminal using a single program. This is currently a terminal browsing application for 4chan, Reddit, Hacker News, and lainchan. Built using the urwid library for python. It also makes use of the 4chan API, the Reddit API, a third-party Hacker News API, and the lainchan API. Development for all sites are still on-going so while basic browsing will work there may be smaller bugs or features than you may notice. Please feel free to notify the dev team by opening an issue, or PRs are always welcome!

To run, first install the dependencies in requirements.txt

pip3 install -r requirements.txt

And then run ./terminus_browser.py

Screenshots

Click on photo for more detail

4chan

Board Index Board View Thread view

Reddit

Subreddit Index Subreddit View Post View

Lainchan

Board Index Board view Thread View

Hotkeys

  • ':' - Puts you in command mode where you can type full commands
  • 'esc' - Puts you in normal mode where the usual hotkeys will work
  • HJKL - Normal vim like navigation for selectable objects

Commands

  • (q)uit(a)ll - Close the program
  • (t)hread [THREAD NUMBER] - open the thread on the current board with the specified number
  • view [PATTERN] - [PATTERN] being [4chan/reddit/hackernews/lainchan/history] currently it will open that site in the current view
  • (h)istory - will go back one level in the history list
  • (s)earch [PATTERN] - will search the current view for the pattern, if pattern is blank it will reset the current view
  • add [reddit/4chan] [PATTERN] - will add the subreddit or board [PATTERN] to the site index specified.

Configuration

  • To change the default site you can modify the config.json file [FCHAN/REDDIT]
  • The config.json file also contains the boards list and the subreddit list

Contributing

Development on TerminusBrowser is active and on-going. If there are any features you want or you're just interested in joining in the discussion the dev team is most active on #TerminusBrowser on the Freenode IRC server

TODO List

  • Display images links on posts
  • Board and Thread fetch information in the footer
  • Filtering options on all pages with information in the footer
  • HJKL movement
  • Full suite of commands
    • Search command for current view
    • Thread command to view thread by number
    • Toggle to show or hide stickied reddit posts
    • Download image(s) for later viewing
    • Filtering reddit comments based on score
  • Toggleable display modes(boxes, tree, cascade)
  • Display comment replies in the info bar at the top of the comment
  • History Frame
  • Quote button full interaction
    • Quotes of OP have the (OP) designator
    • Interacting with Quotes displays a preview of said Quote
    • Size of preview depends on size of quote being previewed
    • Chain Quote Previews together to view up the quote tree
  • Split view based on hotkeys
  • Timed updating of threads
  • Posting from the client
  • Full Reddit Functionality
    • Pagination
    • Tree comment structure
  • Hacker News Functionality
  • Lobster.rs Functionality
You can’t perform that action at this time.