Skip to content

WikiUp is a CLI tool which assists you to search and find your need via Wikipedia.

License

Notifications You must be signed in to change notification settings

mhadaily/wikiup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WikiUP,a Wikipedia lookup helper in your terminal

[STILL UNDER DEVELOPMENT, WAITING FOR VERSION 1.0.0 TO BE RELEASED SOON]

This is a simple CLI tool that helps you to lookup about what you need to know more via Wikipedia and let you open is in your terminal.

Installation

NPM
npm install --global wikiup // or use -g instead of --global
Yarn
yarn global add wikiup 

Test

npm test

Commands

 Commands:

    search|s [options] <yourText>  as easy as typing your phrase or word

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

  Default:

    Target Language is English
    Default search limit is 3

  Usage:

    $ wikiup s "love" 
    $ wikiup s "love"  -r 10
    $ wikiup s "love"  --result 10

TODOs

  • Ask prompt to open the search result
  • Highlight text within a text search result
  • Possibly add text to speech
  • Search within category and list them
  • make it ready to run on all node versions

Bug

Please open your issue HERE

Contribution

Feel free to fork this project and make that better.

Disclaimer

Please do not use this package in production or for heavy usage.

About

WikiUp is a CLI tool which assists you to search and find your need via Wikipedia.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published