Lightweight CLI tool for instantly explaining command-line flags without digging through man pages
Project description
Lightweight CLI tool for instantly explaining command-line flags without digging through man pages
whattheflag helps you understand command-line flags and options for many popular CLI tools directly in your terminal.
Simply prepend whattheflag to a command to see what its flags mean.
Features
- Explain command-line flags for many popular CLI tools
- Understand copied shell commands by translating their flags
- Expand combined short flags (e.g.
-fsSL) - Show both short and long flag versions when available
- Display explanations in a clean table format
- Show all known flags for a specific tool
Installation
pip install whattheflag
Usage
All functionality is available through the command line interface.
You can:
- Search for a specific tool (
whattheflag df) - Search for a specific flag or option (
whattheflag curl -fsSL --help) - Display an overview of all available options (
whattheflag tools)
Example Commands
Overview for a Tool
Shows all available flags and options for a tool.
whattheflag df
| Flag | Long | Description |
|---|---|---|
| -a | --all | Include dummy filesystems |
| -B | --block_size | Specify block size |
| -h | --human_readable | Print sizes in human readable format |
| -i | --inodes | List inode information |
| --total | Produce grand total | |
| -T | --type | Print filesystem type |
Explanation for a Specific Flag
Shows the meaning of the provided flags.
whattheflag curl -fsSL --help
| Flag | Long | Description |
|---|---|---|
| -f | --fail | Fail silently on HTTP errors |
| -s | --silent | Silent mode, do not show progress |
| -S | --show-error | Show error even when using silent mode |
| -L | --location | Follow HTTP redirects |
| -h | --help | Show help for curl |
List Supported Tools
Lists all supported tools.
whattheflag tools
Supported Tools
| awk | curl | df | docker |
| du | find | git | grep |
| gzip | jq | kubectl | nc |
| ps | rsync | sed | ssh |
| tar | top | unzip | wget |
| xargs | yq | zip |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file whattheflag-0.1.2.tar.gz.
File metadata
- Download URL: whattheflag-0.1.2.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
83570ac509c32c1f9dce39d90e3ca7eed99b0033de174827eac04d7647a694ce
|
|
| MD5 |
d759d30165f0ca707599aa77d2a9ab45
|
|
| BLAKE2b-256 |
32b0ef86103490d44afe74211908b85da57aa33936e75cf21b557a25e4f5c7fd
|
File details
Details for the file whattheflag-0.1.2-py3-none-any.whl.
File metadata
- Download URL: whattheflag-0.1.2-py3-none-any.whl
- Upload date:
- Size: 18.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2878cb72af58f5a647666d47e054b043aa1d7a3ea282751472fa7ced5cbcccee
|
|
| MD5 |
9bf74ce5d07e0b549cd97d3d0c1ea529
|
|
| BLAKE2b-256 |
43e583f86faadf1f43c272dbeb9295511625982ff540fb05caaab6f8a814628a
|