WIKI-TUI

A simple and easy to use Wikipedia Text User Interface

Note: wiki-tui is still under active development and breaking changes can occur. Please always check the release notes before upgrading

Rewrite and the main branch

wiki-tui is currently going through a complete rewrite (we're switching from cursive to ratatui). That means that the main branch is going to have an in-development and unfinished version of wiki-tui for the duration of the rewrite. Please keep that in mind when compiling from source.

Since this is a fairly large change, there won't be new versions released until the rewrite is complete.

Feel free to try the development version out!

You can find the installation instructions, configuration options, more preview images, a feature overview and more on our website, wiki-tui.net

What can it do?

• Browse wikipedia in a TUI. Features of the TUI include:

  • Rich search results (result previews, more information on results, continue the current search)
  • Open articles in layers (press ESC to close a layer)
  • A Table of Contents with support for jumping to the section in the article
  • Rich article view (functioning links, lists, headers)
  • Switch the language of an article

• VIM-like Keybindings:

  • Basic movement
  • Goto Top / Bottom
  • Half up / down

• It's customizable (we plan on having more features in the future):

  • Change the global and local theme of individual UI components
  • Change some of the keybindings
  • Disable features (Table of Contents, Links)
  • Customize the Table of Contents (position, title format, sizes, etc.)
  • Change wikipedias language (even on the fly)
  • Logging

How it looks

Note: This screenshot was taken on iTerm2 (MacOS) with the Fira Code font

Similar Projects

• hexrcs/wiki-cli
• yashinghcodes/wik

Acknowledgements

• cursive
• rust
• mkdocs
• mkdocs-material

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Builditluc 🤔 💻 📖 🐛	0323pin 🐛 📦	legendofmiracles 📦	Thomas 📦 🐛	Nuno Teixeira 📦	cshjsc 💻	Dmitry Kozlovtsev 🐛
Enoumy 💻	ethamck 🎨 📦

This project follows the all-contributors specification. Contributions of any kind welcome!