https://github.com/codezeilen/wat
Wat are this? The wat CLI tool helps you find out what all the things in your Linux system are.
https://github.com/codezeilen/wat
cli console documentation help linux manual python python3 shell terminal tldr
Last synced: 4 months ago
JSON representation
Wat are this? The wat CLI tool helps you find out what all the things in your Linux system are.
- Host: GitHub
- URL: https://github.com/codezeilen/wat
- Owner: codeZeilen
- License: mit
- Created: 2023-01-04T18:22:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T12:45:49.000Z (5 months ago)
- Last Synced: 2025-01-23T13:30:26.620Z (5 months ago)
- Topics: cli, console, documentation, help, linux, manual, python, python3, shell, terminal, tldr
- Language: Python
- Homepage: https://pypi.org/project/wat-terminal/
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# wat - wat are this?
`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](https://github.com/codeZeilen/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](https://github.com/navdeep-G/samplemod).
The implementation internally uses the Python-client of [tldr](https://github.com/tldr-pages/tldr-python-client/).