wiki-tui 0.9.1

A simple and easy to use Wikipedia Text User Interface
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

You can use the CLI arguments to further fasten up your wikipedia experience in
wiki-tui. While there are more QOL-features and arguments for the CLI planned,
those are the things you can currently do with the CLI:

- [Faster search](#search-query-argument)
- [Change the language](#changing-the-language)
- [Print cache and config path](#print-cache-and-config)
- [Adjust the logging level on the fly](#change-logging-level)

!!! 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

### Changing the language

```
wiki-tui --language <language-code>
```

!!! example
    If you want to change the language to German, simply pass it in as a argument
    
    ```
    wiki-tui --language de
    wiki-tui --language german
    wiki-tui --language deutsch
    ```

    It will open wiki-tui with the language set to German

!!! tip
    You can also use the short variant of this argument `-l` to change the language
    
    ```
    wiki-tui -l de
    ```

For more information about language changing, view [this page](../configuration/api.md#supported-languages) of the docs

### Print cache and config

To view the cache directory where the log file is written to,
use this command

```
wiki-tui --cache-dir
```

If you want to instead view the path for the config file, use this command

```
wiki-tui --config-path
```

If you want to view the path for the theme configuration file, use this command

```sh 
wiki-tui --theme-config-path
```

### Change logging level

You can also change the configured logging level. This can be done by either using a number to set
the level or by using the name of the logging leven (for more information, see the table below)

```sh
wiki-tui --level <level>
```

!!! example
    Changing the level to `Debug`

    ```sh
    wiki-tui --level 4
    ```

Available values are:

| Value | Name | Level | 
|---|-------|-------|
| 5 | `trace`| Trace |
| 4 | `debug`| Debug |
| 3 | `info`| Info  |
| 2 | `warn`| Warn  |
| 1 | `error`| Error |
| 0 | `off` | Turn off Logging |