Giter Club home page Giter Club logo

turkey's Introduction

Build Status

Turkey - Terminal Wiki Browser

Turkey is a terminal application for browsing Mediawiki websites, such as wikipedia.org. See example.txt for some example wikis to browse. Windows is not supported at this time.

Installation

node.js is required

npm install -g turkey

make sure it works

tky --version

Usage Example

Load English language wikipedia main page

tky

Equivalent

tky -w en.wikipedia.org -p /w

Load specific article

tky -a elephant

Load another wiki

tky -w awoiaf.westeros.org -a Essos

dump to console

tky -a elephant --dump

screenshot

Command Line - tky

arg description example default
-w --wiki <url> wiki url en.wikipedia.org en.wikipedia.org
-p --path <path> wiki path /w /w
-a --article <article_name> article name to read elephant Main_page
-d --dump dump to console NA NA

Terminal UI Keyboard Shortcuts

shortcut description
esc, q, C-c quit
spacebar, C-s focus search bar
C-b focus article box
up arrow back, hit enter when you find the article you would like to reload
down arrow forward, hit enter when you find the article you would like to reload
d highlight and scroll to next link and hit enter to load
a highlight and scroll to previous link and hit enter to load
s highlight and scroll to next header (from current link)
w highlight and scroll to previous header (from current link)

Tested OS

  • OSX
  • Ubuntu

turkey's People

Contributors

scrussell24 avatar dependabot[bot] avatar

Stargazers

 avatar Steven Edwards avatar Timo Tijhof avatar

Watchers

James Cloos avatar  avatar

turkey's Issues

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.