#wikipedia #cli #web #command-line-tool #command-line-app

app wikipe

A simple tool to search and read Wikipedia articles in the terminal

1 unstable release

0.1.0 Dec 19, 2022

#18 in #wikipedia

MIT license

20KB
174 lines

wikipe-tan

Wikipe

Version Downloads License

❇️ Wikipe ❇️ is a tool to search Wikipedia from the command-line. Given a search query, it returns a list of matching Wikipedia articles, which can be opened to display their contents or directly opened in a browser from the terminal. Articles can be navigated through the terminal. wikipe supports sequential searches within a single instance.

Installation

If you have Rust and Cargo installed on your machine, you can install this app directly from crates.io.

 $   cargo install wikipe

Usage

Wikipe currently takes the following arguments.

    -l|--lang [String] Wikipedia article language in the form of an ISO language code

You can run wikipe directly from the terminal with the wikipe command alongside a query to search on Wikipedia. You can supply a language ISO code with the -l flag. For example, by setting the language to es, Wikipe will return articles in Spanish.

$   wikipe <search_query> -l <language>

Wikipe will return a list of relevant articles for that given search term, and ask you to select an article to view. At the moment, you can choose to view a summary of the article, or the entire article in your terminal. Check the roadmap for upcoming features.

Contributing

This is still a WIP so if you find any bugs or have any suggestions for features or better code, please submit either an issue or a pull request ^_^

Naming

Wikipe is named after Wikipedia's unofficial mascot, Wikipe-tan!
Wikipe-tan was created in 2006 and since then her popularity as a Wikipedia mascot has sadly dwindled. Hopefully you can have some fun exploring the world's encyclopedia with Wikipe-tan again.

Roadmap

  • Link Support: Browse links on a Wikipedia article.
  • Better Navigation: A better navigation experience, to allow navigation between pages like you would on Wikipedia.
  • TUI: Convert the app to a full TUI experience, using frameworks such as Rust-TUI or Cursive. This would allow for better navigation and rendering of article information.
  • Image Support: Render the main image from articles in ASCII within the TUI.

Motivation

I've been personally wanting to learn Rust for a while now so whilst I had some free time I thought I'd create a simple CLI app. With that being said, I'm not a Rust export so if you have any suggestions or improvements in terms of code quality, please open a pull request or an issue and I'll endeavor to answer and help in any way I can! I'm always looking to improve. Why Wikipedia? I use Wikipedia every single day. It's by far the most useful and valuable part of the internet for me, and I wanted to celebrate that by creating this app. If this app brought you some value or joy, and you wanted to support it any way, I'd ask if you can instead donate to Wikipedia directly via their donation page!

Dependencies

~4–15MB
~151K SLoC