https://github.com/theaxelander/wtf
https://github.com/theaxelander/wtf
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/theaxelander/wtf
- Owner: TheAxelander
- License: mit
- Created: 2025-04-12T09:47:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-04T11:26:10.000Z (6 months ago)
- Last Synced: 2026-01-08T10:56:19.398Z (5 months ago)
- Language: Python
- Size: 307 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wtf
**A small helper to display cheatsheets, shortcuts and others inside your terminal.**
## Requirements
- fzf
- config file (see Configuration)
## Installation
Download [latest release](https://github.com/TheAxelander/wtf/releases/latest) and install it via `pipx`
``` bash
apt install python3 python3-pipx
pipx install wtf-x.x.x-py3-none-any.whl
```
Optionally create a venv for development
``` bash
git clone https://github.com/TheAxelander/wtf.git
cd wtf
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
## Configuration
See below example config file which is required in `~/.config/wtf/wtf.conf`
``` ini
CHEATSHEET_REPO=~/.local/share/wtf
PREVIEW_COMMAND=cat #You could also use wtf itself to render the file inside the fzf preview
```
## Usage
Without any parameter `fzf` is used to select a file which is then rendered. The content must be Markdown-based.
``` bash
wtf
>>> fzf screen is shown
```
Appending a `sheet` (simple file name) renders the file directly without any further selection
``` bash
wtf tmux
>>> tmux file will be displayed
```
By passing `--update-repo` you can pull the latest changes for your cheatsheet repo
``` bash
wtf --update-repo
```