Git Product home page Git Product logo

gowiki's Introduction

GoWiki

A command line utility in GO Lang for reading Wikipedia documents.

Setting-up GoWiki

  1. Install Go for your preferred platform
  2. Install the Color package as follow:
    go get github.com/fatih/color
  3. Clone the GoWiki repository:
    git clone https://github.com/rainandwind0/gowiki.git
  4. From the root of the project directory issue:
    go run src/main.go [OPTIONS]

Usage

To see usage statements: go run src/main.go -h
-f write the article to file instead of console (default: false)
-l the of search results to be displayed (default: 5)
-s a search term
-v print version number

Chain any of the following flags together to get your results

Run with prompts: go run src/main.go
Preset search term: go run src/main.go -s="search string"
Limit the number of results to be displayed: go run src/main.go -l=10
See the version number: go run src/main.go -v
Search with a preset term with a set limit and the selected article is written to file:
go run src/main.go -f -l 10 -s "Oprah"

NOTE: flag values can be set with the equal (-s="Oprah") or without (-s "Oprah")

Todo:

  • Add option to select only intro of returned article
  • Write to file
  • Pretty print (especially with nested heading)
  • Binary installer

gowiki's People

Contributors

bigcheeze45 avatar rainandwind0 avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

bigcheeze45

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.