Contributors Stargazers Issues MIT license GitHub Workflow Status Lines of code


Logo

WIKI-TUI

A simple and easy to use Wikipedia Text User Interface

Breaking Changes

As of 0.3.4 wiki-tui uses the .toml format for configuration. .ini configs won't work!

Preview

Features

wiki-tui currently has these features: - Browse through Wikipedia (Set the language by changing the url in the config) - Uses webscraping and a custom view to display wikipedia articles in the terminal - Use links to open other articles

These features are planned: - View and interact with more elements of wikipedia articles (like tables, images, etc.)

How it looks

image image image
Note: These Screenshots were taken on alacritty (MacOS) with the spaceduck theme and the Sauce Code Pro font

Installation

The binary executable is wiki-tui

Cargo

cargo install wiki-tui

Configuration

Location of the config file

MacOS and Linux

$HOME/.config/wiki-tui/config.toml

Windows

C:\Users\{USERNAME}\wiki-tui\config.toml

Settings

Default configuration ```toml [api] base_url = "https://en.wikipedia.org/" # this is the url of wikipedia, it can be changed to change the language of wikipedia

The settings here are all colors and can be set by either the name of the color or a hex string (valid formats are: #ffffff, #fff)

The actual colors displayed in your terminal can change depending on your terminal settings

[theme] background = "white" # color used for View backgrounds title = "red" # color used for the title text highlight = "red" # color used for highlighting text highlightinactive = "blue" # color used for highlighting inactive text highlighttext = "white" # color used for highlighted text text = "black" # color used for the text search_match = "red" # color used for a search match in the results view

[logging] enabled = true # can be either true or false. enables/disables logging logdir = "wikitui.log" # location of the file where the log will be written to log_level = "Info" # log level to be used, can be Debug, Info, Warn, Error ```

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Switch to the experimental branch
  3. Commit your Changes
  4. Push to the branch
  5. Open a Pull Request

Logging

As of 0.3.2 you can no longer configure the logger with a .yml file

Acknowledgements