Giter Club home page Giter Club logo

reddit-shell's Introduction

reddit shell

reddit shell is a web based linux shell emulator written in JavaScript that lets you browse and interact with reddit via command line https://redditshell.com/

Features

  • Browse public subreddits, posts, comments, and users.
  • Iterate through comment chains and post indexes.
  • Watch subreddits for new posts
  • Scope-based tabbed auto-completion of commands, subreddit names, and usernames (double tab for list view)
  • Search for posts, comments, and users.
  • Login authentication via OAuth 2
  • Upvote/downvote posts and comments
  • Comment/reply posts and comments
  • Display inline images for image posts # set img on
  • Change limit on number of retrieved posts, comments # set limit [auto|1-100]
  • Command format exceptions that cover most preferences

Future TO-DO

  • more logged in user actions
  • multireddit views

Example Commands

  • # ls - list posts from the frontpage
  • # ls funny top - lists posts from /r/funny sorted by top rated
  • # cd .. - go back to frontpage listings
  • # view comments 3 - views comments for the specified post index
  • # view more comments - load more comments for current post scope

Commands

  • list
    • Aliases: ls, cd
    • Options:
      • [next|previous] - can only be used on result set
      • [subreddit] [new|rising|top|controversial] - sort applies to subreddits only (not frontpage)
      • [subreddit] [next|previous] - can only be used on result set
      • [..|-|~/] - common directory nav commands - can only be used with the "cd" alias
  • Description: list posts from the the specified subreddit or the front page if no subreddit specified and sorts by optional new, rising, top, controversial. Use the "cd" alias to forwards and backwards with the [..|-|~/] options
  • list subreddits
    • Aliases: [ls, cd], subs
    • Options:
      • [next|previous] - can only be used on result set
    • Description: list all public subreddits available on reddit
  • view content
    • Options:
      • [index] - can only be used on result set
    • Description: opens the permalink of the specified post index in a new window.
  • view comments
    • Options:
      • [index] [confidence|top|new|hot|controversial|old|random|qa] - can only be used on result set
    • Description: loads the comments of the specified post index.
  • view more comments
    • Options:
      • [index] [confidence|top|new|hot|controversial|old|random|qa] - can only be used on result set
    • Description: Loads more comments from the post scope if no index is given and there are posts to load, otherwise loads the specified comment tree for the index given.
  • watch
    • Options:
      • [subreddit]
    • Description: Watches the specified subreddit for new posts
  • search
    • Options:
      • [search term]
      • [next|previous] - can only be used on result set
    • Description: Searches reddit for the specified search term.
  • user
    • Options:
      • [username]
      • [username] [next|previous] - can only be used on result set
    • Description: Loads all public comments and posts the specified user has made
  • login
    • Description: redirects your browser to reddit.com and requests permission for reddit shell to load and use user data
  • upvote
    • Options:
      • [index]
    • Description: Upvotes the specified post or comment index
  • downvote
    • Options:
      • [index]
    • Description: Downvotes the specified post or comment index
  • post comment
    • Options:
      • [text] - can only be used on view comments result set
    • Description: Post a comment to the current post in scope
  • post reply
    • Options:
      • [index] [text] - can only be used on view comments or view more comments result set
    • Description: Post a reply to the specified comment index
  • logout
    • Description: De-authenticates the currently logged in user
  • settings
    • Aliases: set
    • Options:
      • [images] [on|off]
        • Aliases: img
      • [limit] [auto|1-100]
    • Description: Changes settings for user preference. Turning images on will show the thumbnail for all image posts. Limit decides how many results to return for posts and comments. "auto" picks the best limit for your screen resolution without having to scroll (unless viewing a nested comment tree)
  • pwd
    • Description: Prints working directory
  • clear
    • Description: Clears the screen
  • about
    • Description: Displays project info and credits
  • help
    • Aliases: cat readme
    • Description: Displays more detailed instructions

Libraries

reddit-shell's People

Contributors

jasonbio avatar

Stargazers

Roman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.