Skip to content

wikr is a simple command line tool that provides quick summaries of Wikipedia articles

License

Notifications You must be signed in to change notification settings

SvenSchneiderDVAG/wikr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wikr

wikr is a simple command line tool that provides quick summaries of Wikipedia articles in German or English.

Features

  • Search for Wikipedia articles
  • Display article summaries directly in the console
  • Support for German and English Wikipedia
  • Caching of search results for faster access
  • Interactive selection for multiple search results

Installation

  1. Ensure that Go is installed on your system.

  2. Clone this Repository:

    git clone https://github.com/SvenSchneiderDVAG/wikr.git
  3. Navigate to the project directory:

    cd wikr
  4. Build the program:

    go build

Usage

wikr [de|en] search term
  • de or en (optional): Selects the language (German or English). Default is German.
  • search term: The term or article title to search for.
  • -max: The maximum number of results to display. Default is 5.
  • -clear-cache: Clear the cache.
  • -version: Show version.

Examples

wikr Eiffelturm
wikr en Albert Einstein
wikr -max 3 Eiffelturm
wikr -clear-cache
wikr -version

Cache

Wikr stores search results in a cache file (.wikr_cache.json) in the user's home directory. The cache is valid for 24 hours.

Dependencies

License

MIT License

Contributes

Contributes are welcome! Please open an Issue or a Pull Request for suggestions or bug fixes.

About

wikr is a simple command line tool that provides quick summaries of Wikipedia articles

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages