Usage

So you've installed wiki-tui, great! (if not, please check the installation guide) This page provides an overview of how to use wiki-tui. If you already feel comfortable with the program, check how you can configure wiki-tui to your needs.

Info

wiki-tui performs its actions synchronously. That means that you have to wait a few seconds after starting the search or opening an article until the window updates. Any keys you press in this wait time will be send after the action finishes

Startup and CLI

You can start wiki-tui by running the following command from you terminal

wiki-tui

This will run the program and you can start browsing wikipedia. If you want, you can use the CLI to fasten up your search.

Tip

You can always run wiki-tui --help to get an overview of available arguments

Search Query Argument

wiki-tui <search-query>

Example

If you already know that you want to search for github you can pass it in as a argument

wiki-tui github

It will open wiki-tui and already start the search so you don't have to type it into the search bar

At the time being there is only this argument that really improves the usability (for the other ones please refer to wiki-tui --help) but in future versions there will be more arguments

Keybindings and Controls

This is a list of all available actions and what the default keybinding for that action is. Configurable actions can be remapped in the config

Action	Default Keybinding	Configurable?
UP	Up
DOWN	Down
LEFT	Left
RIGHT	Right
NEXT TAB	Tab
PREV TAB	Shift+Tab
OPEN	Enter
QUIT	Q