https://github.com/anuragbhaskarya/wtf
WTF - A lightning-fast offline command-line dictionary tool for Linux that helps you look up and manage definitions right from your terminal. Simple, fast, and easy to use!
https://github.com/anuragbhaskarya/wtf
anurag anuragbhaskarya bhaskarya cli-app cli-dictionary cli-tool dictionary dictionary-application linux-app linux-shell terminal-app terminal-based wtf
Last synced: about 1 month ago
JSON representation
WTF - A lightning-fast offline command-line dictionary tool for Linux that helps you look up and manage definitions right from your terminal. Simple, fast, and easy to use!
- Host: GitHub
- URL: https://github.com/anuragbhaskarya/wtf
- Owner: AnuragBhaskarya
- License: mit
- Created: 2024-12-15T13:33:26.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-06T17:50:14.000Z (4 months ago)
- Last Synced: 2025-03-25T05:19:45.868Z (about 2 months ago)
- Topics: anurag, anuragbhaskarya, bhaskarya, cli-app, cli-dictionary, cli-tool, dictionary, dictionary-application, linux-app, linux-shell, terminal-app, terminal-based, wtf
- Language: C
- Homepage:
- Size: 3.17 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WTF - 🤔?
#### **A lightning-fast offline command-line dictionary tool for Linux that helps you look up and manage definitions right from your terminal. Simple, fast, and easy to use!**
## 🚀 Features:
- **Quick Term Lookup**: Get definitions instantly
- **Add Custom Definitions**: Add your own terms and definitions
- **Remove Definitions**: Remove single or multiple definitions with interactive prompts
- **Case-Insensitive Search**: Search terms in any case (like "linux", "Linux", or "LINUX")
- **Simple Interface**: Easy-to-use command-line commands
- **Local Storage**: All definitions stored locally in your home directory
- **Auto-Update**: Dictionary gets updates if the repo has an update. (automatically or forced)
## 🎨 Visual Elements
---
- **Added `tree-style` display for better readability**
- **Implemented color-coded output for different message types**
- **Added ASCII art logo and version display**
### #Our CLI features an elegant and informative update interface:
- **Rich Progress Bar**: A vibrant, full-width progress bar shows real-time download status
- **Clean Typography**: Crisp, coloured font for optimal terminal readability
- **Status Messages**: Clear, concise update notifications
## 📦 Installation:
### Option 1: Install from Release (Recommended)
---
**1. Download the latest `.deb` package from** ***[Releases](https://github.com/AnuragBhaskarya/wtf/releases)***
**2. Install using:**
```bash
sudo dpkg -i wtf_*x86_amd64.deb
```
### Option 2: Build from Source
---
**1. Clone the repository**
```
git clone https://github.com/AnuragBhaskarya/wtf.git
```
**2. Navigate to the wtf directory:**
```
cd wtf
```
**3. build & install**
```
make
sudo make install
```
### Option 3: Using the Package Build Script
---
**1. Clone the repository**
```
git clone https://github.com/AnuragBhaskarya/wtf.git
```
**2. Navigate to the wtf directory:**
```
cd wtf
```
**3. Run the package build script:**
```
./makedeb.sh
```
**4. Install the generated package:**
```
sudo dpkg -i wtf_*.deb
```
## 🎯 How to Use:
- **Looking up a Term**
```
wtf is
#example: wtf is linux
```
- **Adding a New Term**
```
wtf add :
#example: wtf add Python:A high-level programming language
```
- **Removing a Term**
```
wtf remove
#example: wtf remove Python
```
- **Recovering a removed Term**
```
wtf recover
#example: wtf recover Python
```
- **To update/Sync Dictionary file (definitions.txt)**
```
wtf sync #For regular updates & checks
```
```
wtf sync --force #To force update & recover any deletion
```
- **version check**
```
wtf -h #or
wtf --version
```
- **To Uninstall ***(Requires sudo permission)*****
```
wtf uninstall #or
wtf --uninstall
```
- **Getting Help**
```
wtf -h
```
## 🔧 System Requirements:
- **Linux** operating system
- Supports both **64-bit (amd64)** and **32-bit (i386)** architectures
## 📁 File Locations:
```bash
# Definitions file
~/.wtf/res/definitions.txt
```
```bash
# Added file
~/.wtf/res/added.txt
```
```bash
# Removed file
~/.wtf/res/removed.txt
```
```bash
# Binary location
/usr/local/bin/wtf
```
## 🤝 Contributing:
**1. Fork the repository**
**2. Create your feature branch** *(`git checkout -b feature/amazing-feature`)*
**3. Commit your changes** *(`git commit -m 'Add some amazing feature'`)*
**4. Push to the branch** *(`git push origin feature/amazing-feature`)*
**5. Open a Pull Request**
## 📄 License:
This project is open source and available under the [MIT License](LICENSE).
## ✨ Support:
- Create an [Issue](https://github.com/AnuragBhaskarya/wtf/issues) for bug reports or feature requests
- Star the repository if you find it useful!
---
***Made with ❤️ by [Anurag Bhaskarya](https://github.com/AnuragBhaskarya)***