Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.14 KB

README.md

File metadata and controls

65 lines (41 loc) · 2.14 KB

wat - wat are this?

Video of a dog being held to various items, captioned with the question: 'wat are this?'. Image based on Jenna Marble's work featuring Kermit the dog.

wat helps you find out what all the things in your Linux system are. You can ask it for information on:

  • executables
  • services
  • bash built-ins
  • packages
  • files and folders (based on wat-pages)

To find out what something is, simply pass the name to wat:

> wat zeitgeist

zeitgeist (package): Zeitgeist is a service which logs the user's activities and 
events (files opened, websites visited, conversations held with other people, etc.) 
and makes the relevant information available to other applications.

> wat /var/spool

/var/spool (directory): This directory contains data which is awaiting some kind of later processing. Data 
in /var/spool represents work to be done in the future (by a program, user, or 
administrator); often data is deleted after it has been processed.

Installation

wat requires Python 3.10. wat runs on most Linux distributions and can be used with MacOS, however with a limited feature set for now.

From PyPi

pip3 install wat-terminal

From repository

  1. Install requirements: pip install -r requirements.txt
  2. Install wat as a command line tool: python3 setup.py install

Usage

usage: wat [-h] [--version] [--update] [--skip-empty-result] [name ...]

positional arguments:
  name                 name of the thing to lookup

options:
  -h, --help           show this help message and exit
  --version            show program's version number and exit
  --update, -u         update the page sources
  --skip-empty-result  if there is no result, don't print anything

Acknowledgments!

The inital repository structure is based on navdeep-G/samplemod.

The implementation internally uses the Python-client of tldr.