Skip to main content

Lightweight CLI tool for instantly explaining command-line flags without digging through man pages

Project description

whattheflag

PyPI Python License Build

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whattheflag-0.1.0.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whattheflag-0.1.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file whattheflag-0.1.0.tar.gz.

File metadata

  • Download URL: whattheflag-0.1.0.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

Hashes for whattheflag-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cd4a3f23edf6bcc236369182a08a0ad48d993243a337632f2a72b8b9b3f6bfd4
MD5 bcefbc0ce07993da43e236cea43d22d6
BLAKE2b-256 7036fe9e36fd37a53c4c92063e80a51d7ac866bba94da52c4fcf27d33f26c0aa

See more details on using hashes here.

File details

Details for the file whattheflag-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: whattheflag-0.1.0-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

Hashes for whattheflag-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61b0e934f4f64e1e4fccb5c37215cf366c0ff86829e878deb1c50024a614c9f7
MD5 4d66c384c37ecdaa5c0ca9116082883f
BLAKE2b-256 83b87e00d2af0ec1e82cbc91997eaa8806a405f21f3bfa0fe92cd50f3e77269a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page