https://github.com/holdhack/shiki

Shiki ~ Wikipedia 🌐 on your Terminal
https://github.com/holdhack/shiki

shell-script wikipedia-api

Last synced: about 1 year ago
JSON representation

Shiki ~ Wikipedia 🌐 on your Terminal

• Host: GitHub
• URL: https://github.com/holdhack/shiki
• Owner: holdhack
• License: mit
• Created: 2017-07-09T15:45:21.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-07-26T16:37:25.000Z (almost 9 years ago)
• Last Synced: 2024-11-02T09:33:02.306Z (over 1 year ago)
• Topics: shell-script, wikipedia-api
• Language: Shell
• Homepage:
• Size: 12.7 KB
• Stars: 42
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Introduction

![shiki in action](http://i.imgur.com/xHzSwVM.png)

This is `shiki`, a neat little script that allows you to browse Wikipedia articles right in your Terminal.

Imagine you're in the zone, don't recognize something and don't want to break your flow by tabbing to your browser: Shiki has you covered!

## Usage

`shiki NASCAR` will give you the article overview/intro to NASCAR, in English.

Furthermore `shiki` has some useful options. These are:

* `--full/-f`: requests the full article

* `--simple/-s`: requests the simple article. This is especially handy if you want a quick understanding of something!

* `NASCAR --language fr`: requests the article in French

So, if you would want to read the full article about 'The Netherlands' in 'Dutch', you would `shiki -f "The Netherlands" -l nl`

Note that 'simple' is a Wikipedia language, and thus can't be combined with the `--language` option.

## Installation

Copy the code into your '.bash_profile', '.zshrc' or '.functions'.  

Another (cleaner) way is to clone this repository and add `source "${HOME}/shiki/shiki.sh"` to one of the aforementioned files.

## With help from…

[Konsolebox](git.io/konsolebox)  

[#bash](http://webchat.freenode.net/?channels=bash) on freenode